oppia: Add valid args, returns & raises docstring for the python files.
The 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
About this issue
- Original URL
- State: closed
- Created 5 years ago
- Comments: 69 (56 by maintainers)
Commits related to this issue
- Merge pull request #1 from lkbhitesh07/lkbhitesh07-patch-1 fixes #7427: added Args,Returns in Docstring of util.py python file — committed to lkbhitesh07/oppia by lkbhitesh07 5 years ago
- Fix part of #7427: Added valid args, returns, raises docstring for pre_commit_linter.py (#7789) * added args * added docstrings * fixed lint errors — committed to oppia/oppia by omshii 5 years ago
- Fix part of #7427: Add valid args docstring for story_domain_test.py (#7832) * Add args to _assert_validation_error docstring * Add args to _assert_valid_story_id docstring * Indent args * W... — committed to oppia/oppia by nadintamer 5 years ago
- Addresses docstring issues in one of the files (prod_validation_jobs_one_off.py) from #7427 — committed to tyleri/oppia by tyleri 5 years ago
- Addresses docstring issues in one of the files (prod_validation_jobs_one_off.py) from #7427 — committed to tyleri/oppia by tyleri 5 years ago
- Addresses docstring issues in one of the files (prod_validation_jobs_one_off.py) from #7427 — committed to tyleri/oppia by tyleri 5 years ago
- Addresses docstring issues in one of the files (prod_validation_jobs_one_off.py) from #7427 — committed to tyleri/oppia by tyleri 5 years ago
- Addresses docstring issues in one of the files (prod_validation_jobs_one_off.py) from #7427 (#7948) — committed to oppia/oppia by tyleri 5 years ago
- Fix part of #7427: Adds args, returns and raises in docstrings of utils.py (#8134) * Adds docstrings for utils.py * Removes trailing whitespace * Shortens line length * Removes Whitespace #2... — committed to oppia/oppia by Arnesh07 5 years ago
- Fix part of #7427: Add args, raises in base.py (#8176) * Add args, raises in base.py * Add type of args * Remove pytest_cache * Fix lint error * Fix lint error * Modify docstring * ... — committed to oppia/oppia by nishantwrp 5 years ago
- Fix part of #7427 Add valid Return Args in main.py * Add valid return args to main.py * Added type missing typeinfo to docstring. * Added another typeinfo to docstring * Removed unneeded typ... — committed to oppia/oppia by Helper2020 5 years ago
- Fix part of #7427 Fixes part of #7427: Add args, raises in exp_domain.py — committed to iamprayush/oppia by iamprayush 5 years ago
- Merge pull request #1 from iamprayush/iamprayush-add-args-raises Fix part of #7427 — committed to iamprayush/oppia by iamprayush 5 years ago
- Fix part of #7427 Add args, raises in exp_domain.py (#8288) * Fix part of #7427 Fixes part of #7427: Add args, raises in exp_domain.py * Add docstring for _convert_v29_dict_to_v30_dict * Add... — committed to oppia/oppia by iamprayush 5 years ago
- Added missing docstrings to core/domain/state_domain.py Fixes part of #7427 — committed to jkoj25/oppia by jkoj25 4 years ago
- Fix part of #7427: Added missing docstring to core/domain/story_domain.py — committed to ananthanandanan/oppia by ananthanandanan 4 years ago
- Fix part of #7427: Added missing docstring to core/domain/story_domain.py (#9184) — committed to oppia/oppia by ananthanandanan 4 years ago
- Fix part of #7427: Added missing docstring to core/domain/story_domain.py (#9184) — committed to h-ARTS/oppia by ananthanandanan 4 years ago
@Showtim3 the Pr od state_domain got merged already Thanks
@Arnesh07 Assigned you…
@edeediong Assigned you… go ahead 😃 this one is all yours