Add valid args, returns & raises docstring for the python files.
See original GitHub issueThe aim of this issue is to implement valid docstring in methods (link below) to implement mandatory check for Args Returns Raises
. Currently most of the files having valid docstrings but some files have missing/invalid format Args Returns Raises
in their docstring. by solving this we can go ahead and work on #6081
To be assigned to a file or for any queries, comment on the thread and tag @aks681 .
PR’s for reference: #8288
We have created a list of files which need valid docstring:
- main.py - @Helper2020
- core/domain/story_domain.py @ananthanandanan
Completed:
- utils.py @arnesh07
- core/domain/exp_domain.py - @iamprayush
- core/domain/state_domain.py @abhayraghuwanshi
- core/controllers/base.py @nishantwrp
- core/domain/prod_validation_jobs_one_off.py @tyleri
- core/domain/story_domain_test.py @nadintamer
- core/jobs_registry.py @ahv15
- scripts/deploy.py @adrijaacharyya
- scripts/pre_commit_linter.py @KatherineAdair
you can check the docstring issues in this doc: https://docs.google.com/document/d/1OiZA4I5ETSDu2K_dYUk2whvdEhV_41exBlPZWdU8cDM/edit?usp=sharing
Issue Analytics
- State:
- Created 4 years ago
- Comments:69 (56 by maintainers)
Top Results From Across the Web
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 >Example Google Style Python Docstrings - Napoleon
This module demonstrates documentation as specified by the `Google Python ... param2: raise ValueError('param1 may not be equal to param2') return True def ......
Read more >"Writes" in Google style Python docstring? - Stack Overflow
In Google style Python docstring, one can specify Args , Returns , Raises as follows. I have many functions that, instead of returning...
Read more >Python Docstring: Documenting And Introspecting Functions
This tutorial explains what is Python Docstring and how to use it to document Python functions with examples.
Read more >Documenting Python Code: A Complete Guide
Package and Module Docstrings · A brief description of what the function is and what it's used for · Any arguments (both required...
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 FreeTop 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
Top GitHub Comments
@Showtim3 the Pr od state_domain got merged already Thanks
@Arnesh07 Assigned you…