spatialmath-python
spatialmath-python copied to clipboard
Documentation outdated for `printline()`
Commit 4251e7957e22f4596c95cfd1adadcd92e79ac4b8 seems to have added the strline() function for getting string representations as a replacement for printline(file=None).
Documentation for SE3 still suggests printline() will output a string when supplied with file=None:

Documentation for the new strline() function also doesn't seem to have been built.
Thanks for noticing that, the docs seem to be out of date on Github pages. I'll get those rebuilt with the next pip release
I've changed this stuff a lot, used to be all done by printline. Are these the right primitives?
I haven't noticed a strong convention in the Python community for "making print flexible enough to meet user needs". There's the extendable custom string formatting, but that looks like it may be a deep rabbit hole.
If it was me, my approach would be maximise flexibility for users by minimising work done here:
- Have a single function that provides all possible "thing to string" conversion functionality
- Make something like NumPy's
set_printoptions()to support changing the default string representation globally / in contexts usingwith(optional) - Drop all support for sending the strings to files, and let users handle that through more generic Python methods available
With the flexibility of maybe swapping out 1 with custom string formatting if you feel the need in the future.