webknossos-libs
webknossos-libs copied to clipboard
webknossos-libs pydoc has bad strings in it
With webknossos 0.14.22 (on Linux), doing either
$ pydoc webknossos
or
$ python
...
>>> import webknossos
>>> help(webknossos)
gets me a lot of unrendered HTML and weird characters embedded in what looks like it wants to be a HTML table. I think these are supposed to be emojis.
It'd be good to rework the docstrings so that they neither expect that emojis can be displayed nor that HTML rendering will be available; neither of these are reliable assumptions for python docstrings.
I recommend having a look at the hosted library docs for a rendered version: https://docs.webknossos.org/api/webknossos.html
Thanks; still will be handy for quick reference to have pydoc be better-behaved, but I'm just getting started with learning the APIs in preparation of figuring out how to trial large-scale proofreading work