ajhynes7/scikit-spatial

Document opperators

Closed this issue · 1 comments

Took me quite a bit of time to realize I can do Point + Vector. I think I have looked at all the documentations, but could not find anything that mentions this.

I think it would be helpful if the various operators that are supported are documented.

From the README:

The primary objects of scikit-spatial (Point, Points, and Vector) are actually subclasses of the NumPy ndarray. This gives them all the regular functionality of the ndarray, plus additional methods from this package.

So you can add them together like regular NumPy arrays.

But you're right that there's no example for adding a Point and a Vector. I can add one to the README, and to the Point and Vector page of the docs.