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

Run mkdocs with --strict flag to catch e.g. docstring parameters out of sync with function parameters #456

Closed
mfisher87 opened this issue Feb 8, 2024 · 2 comments · Fixed by #498
Closed

Run mkdocs with --strict flag to catch e.g. docstring parameters out of sync with function parameters #456

mfisher87 opened this issue Feb 8, 2024 · 2 comments · Fixed by #498
Labels
impact: automation CI, CD, or other automation impact: documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Collaborator

Opened from discussion: #448 (comment)
@mfisher87 mfisher87 added impact: documentation Improvements or additions to documentation impact: automation CI, CD, or other automation labels Feb 8, 2024
@jhkennedy
Copy link
Collaborator

jhkennedy commented Feb 8, 2024 •
edited
Loading

For the docstring parameters, I suspect #454 would solve that. There's other warnings MkDocs might raise as well, so it's not a bad idea to do both.

@mfisher87
Copy link
Collaborator Author

Resolved by #498

@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in earthaccess project May 21, 2024
@mfisher87 mfisher87 linked a pull request May 21, 2024 that will close this issue
Improve documentation structure #498
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impact: automation CI, CD, or other automation impact: documentation Improvements or additions to documentation
Projects
earthaccess project
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation structure nsidc/earthaccess
2 participants
@mfisher87 @jhkennedy