log_point
expected shape and error on wrong shape
#1642
Labels
😤 annoying
Something in the UI / SDK is annoying to use
good first issue
Good for newcomers
🐍 Python API
Python logging API
Describe the annoyance
Docs for
log_point
suggests that it requires shape (2,1) or (3,1). However it also works with (2,) and (3,) which would arguably be more standard. So the docs should be changed on this point. The shape suggested in the docs is also inconsistent, sincelog_points
takes (N,2) or (N,3).Furthermore it does not work when passing a (1,2) or (1,3) array instead giving a wrong error message:
To Reproduce
Expected behavior
I see two reasonable options:
log_points
, since iterating over such an array yields arrays with shape (2,) and (3,).Whichever is chosen, the docs should reflect this. Right now one might do some unnecessary reshaping before calling the function.
Desktop (please complete the following information):
The text was updated successfully, but these errors were encountered: