Skip to content

Check all parameters are in the docstrings #437

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
Open
JoeZiminski opened this issue Oct 1, 2024 · 0 comments · May be fixed by #482
Open

Check all parameters are in the docstrings #437

JoeZiminski opened this issue Oct 1, 2024 · 0 comments · May be fixed by #482
Labels
bug Something isn't working

Comments

@JoeZiminski
Copy link
Member

Listing as a bug (in the documentation, if such a thing is possible). The parameters for get_next_sub are not complete in the API docs. Need to check all parameters are represented in the docstring. I think it is possible to add linting to sphinx to ensure this is always the case.
@JoeZiminski JoeZiminski added the bug Something isn't working label Oct 1, 2024
@Transyltooniaa Transyltooniaa linked a pull request Mar 11, 2025 that will close this issue
Open
7 tasks
@JoeZiminski JoeZiminski linked a pull request Mar 12, 2025 that will close this issue
completing docstring for parameters of get_next_sub #482
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

completing docstring for parameters of get_next_sub Transyltooniaa/datashuttle
1 participant
@JoeZiminski