docs: adds parameter descriptions for endpoints and incorporates the latest epidatr docs updates#45
Merged
JavierMtzRdz merged 30 commits intodevfrom Feb 12, 2026
Merged
docs: adds parameter descriptions for endpoints and incorporates the latest epidatr docs updates#45JavierMtzRdz merged 30 commits intodevfrom
JavierMtzRdz merged 30 commits intodevfrom
Conversation
This helps to render NumPy style docstrings as those provided in the package.
dshemetov
approved these changes
Feb 11, 2026
Contributor
dshemetov
left a comment
dshemetov
left a comment
There was a problem hiding this comment.
I didn't try compiling this locally, figured you already did.
praise: thanks for using the napoleon extension, definitely looks a lot cleaner.
praise: thanks for porting all the epidatr docstrings over here.
I spot checked a few and they looked good to me. We can keep tweaking in follow up PRs, but this is already an improvement.
| Private API key. | ||
| locations : StringParam | ||
| Geographic locations to return. Supports a single string or a sequence of strings. | ||
| See `Geographic Codes <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__. |
Contributor
There was a problem hiding this comment.
What do the __ at the end do?
Contributor
Author
There was a problem hiding this comment.
It is the Sphinx syntax for external links.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
This PR provides details about the required parameters according to numpy docsting, adds references to the updated delphi-epidata documentation, and incorporates changes to the documentation from cmu-delphi/epidatr#324.
Prerequisites:
devbranchdev