Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

webknossos-libs pydoc has bad strings in it #1071

Open
pgunn opened this issue May 15, 2024 · 2 comments
Open

webknossos-libs pydoc has bad strings in it #1071

pgunn opened this issue May 15, 2024 · 2 comments
Labels

Comments

@pgunn
Copy link

pgunn commented May 15, 2024

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.

@pgunn pgunn added the bug label May 15, 2024
@hotzenklotz
Copy link
Member

I recommend having a look at the hosted library docs for a rendered version: https://docs.webknossos.org/api/webknossos.html

@pgunn
Copy link
Author

pgunn commented May 15, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants