-
Notifications
You must be signed in to change notification settings - Fork 91
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.
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
Clarify that temporal and bbox args must be tuples in docstrings, fix docstring formatting #448
Conversation
Addresses #279, but does not resolve it.
- pip | ||
- pip: | ||
- poetry | ||
- markdown-callouts>=0.2.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This enabled me to build docs without messing with Poetry. Wasn't sure if this is intentional, as CONTRIBUTING.md doesn't really specify.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion, this clarifies the inputs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this is ready to go now.
Wow, thanks Daniel for going all out on these docstrings!!! We needed this :) |
@mfisher87 , @jhkennedy , @andypbarrett , we could enable linting of docstrings via ruff this way. What do you think? I just ran it and got many more things to potentially fix... |
Heck yes, thank you for looking in to that!!! Should we break that in to another PR so we can merge this one? |
sounds good to me 👍 Once any one else approves it —e.g., @mfisher87, @andypbarrett? — I'll merge it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me!
Addresses #279, but does not resolve it. This work exposed and addresses a couple of concerns, but there are some still I think that need more work.
Docstring formatting
On the
main
branch, there are some formatting errors that are causing key information to be omitted from the docs. It seems really easy to make these mistakes, and Mkdocs doesn't complain about them! How can we protect ourselves?Parameters:
will cause the entire parameters block to be formatted like a code block instead of parsed.strategy (String):
duplicates the type (str
) in the function signature. Mkdocs will pick up the type from the function signature so we don't need to keep these values in sync over time.📚 Documentation preview 📚: https://earthaccess--448.org.readthedocs.build/en/448/