Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Docstring for some modules does not look right
See original GitHub issueDoc string for sys module with markdown style comes back with strange markup. This might be a general problem with docstrings. This is just part of it, that we get back from jedi-language-server:
\_enablelegacywindowsfsencoding -- [Windows only]
**stdin** -- the original stdin; don't touch!
**stdout** -- the original stdout; don't touch!
**stderr** -- the original stderr; don't touch!
**displayhook** -- the original displayhook; don't touch!
**excepthook** -- the original excepthook; don't touch!
Actual:
Expected:
Issue Analytics
- State:
- Created 3 years ago
- Comments:6 (6 by maintainers)
Top Results From Across the Web
python - How do you fix "Missing module docstringpylint ...
I think the warning missing doc string is from your py file not from import random. Try adding some doc string at the...
Read more >Intellisense not showing docstrings from /lib/site-packages ...
Create a Python 2.7.11 virtual environment using virtualenv. Import some module from /lib/site-packages. Type or begin typing an object name ...
Read more >How should docstrings be used in modules with one class?
Just put the docstring in the class and forget the module level docstring. If it's only one class per module (and you strictly...
Read more >Python Docstrings Tutorial : Examples & Format for Pydoc ...
See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.
Read more >Python Docstrings (With Examples) - Programiz
Python docstrings are the string literals that appear right after the definition of a function, method, class, or module. Let's take an example....
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@bollwyvl thanks for calling that out, fixed in
0.25.3. Per @krassowski , I’ve relaxed the version constraint to allow anything below1.0fordocstring-to-markdown.@karthiknadig I believe this specific issue involving the
sysmodule is resolved. If you notice anything else that’s wonky, please open a new issue.