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.
Extensively document the methods
See original GitHub issueI’m submitting a
- [v] feature request.
Current Behaviour
Methods’ docstring do not list inputs in signatures
Expected Behaviour:
Every method should have a docstring in this format:
"""
Extensive explanation of what the method does.
:param input1: description of the input1
:param input2: description of input2
:return return_type: description of returned object
"""
Issue Analytics
- State:
- Created 6 years ago
- Reactions:1
- Comments:7 (7 by maintainers)
Top Results From Across the Web
Software Documentation Types and Best Practices - Prototypr
Agile Project Management: Best Practices and Methodologies ... This document should be clear and shouldn't be an extensive and solid wall of text....
Read more >A Cross-document Semantic Enhancement Method for Visual ...
The introduction of multimodal information and pretraining technique significantly im- proves entity recognition from visually-rich.
Read more >HR Documentation: A Complete Guide (With Best Practices)
Maintaining extensive records allows the HR department to keep a detailed history of important events in the workplace. Documentation can ...
Read more >What is a document and how does it work? - TechTarget
Different methods are used to store digital and nondigital documents. A nondigital or paper document can be physically stored in a file cabinet, ......
Read more >What is Process Documentation: Complete Guide with Template
Process documentation outlines the exact steps needed to complete a task or process from start to finish. Learn more and get our free...
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
@Mec-iS Working on documenting app.py
Work on Github is distributed by definition. Everybody that want to participate can provide a PR and then PRs for the same issue can be confronted. This way it is the best code that is merged, so it may happen that a developer wrote one docstring better than anoher, and the best docstrings can be picked and put in the same merged PR.