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.

Sign up for GitHub

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

Jump to bottom

Add missing docstrings #126

Closed
5 of 6 tasks
5A11 opened this issue Mar 30, 2022 · 3 comments · Fixed by #265
Closed
5 of 6 tasks

Add missing docstrings #126

5A11 opened this issue Mar 30, 2022 · 3 comments · Fixed by #265
Assignees
@VijaySharma815

Comments

@5A11
Copy link
Member

5A11 commented Mar 30, 2022 •
edited by VijaySharma815

This is a tracking issue for missing docstrings in CosmPy. We need to prioritise the Aerial package which upon completion unblocks #225. The following error codes are disabled. One by one we should enable and fix the issues:

  • DAR401: Missing exception(s) in Raises section in docstrings
  • D202: 1 blank line required between summary line and description in docstrings
  • D205: No blank lines allowed after function docstring in docstrings
  • D400: First line should end with a period in docstrings
  • D401: First line should be in imperative mood in docstrings
  • D403: First word of the first line should be properly capitalized in docstrings
@5A11 5A11 mentioned this issue Mar 30, 2022
Merged
@5A11 5A11 self-assigned this Jun 21, 2022
@5A11 5A11 mentioned this issue Jul 5, 2022
Closed
@5A11 5A11 changed the title Aerial docstrings + reference API Aerial docstrings Aug 2, 2022
@5A11 5A11 removed their assignment Aug 2, 2022
@5A11 5A11 changed the title Aerial docstrings Add missing docstrings Aug 2, 2022
@5A11 5A11 mentioned this issue Aug 2, 2022
Closed
3 tasks
@VijaySharma815
Copy link
Contributor

PR: #217

@VijaySharma815
Copy link
Contributor

WIP PR: #265

@VijaySharma815 VijaySharma815 linked a pull request Sep 4, 2022 that will close this issue
cleanup: Add missing docstring #265
Merged
@5A11
Copy link
Member Author

5A11 commented Sep 21, 2022

Closing this issue as most are applied. Will do another round of cleanup later.

@5A11 5A11 closed this as completed Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@VijaySharma815 VijaySharma815

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

cleanup: Add missing docstring fetchai/cosmpy
2 participants
@5A11 @VijaySharma815