Update function documentation #78
Merged
Conversation
This file contains 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
pearsonca
reviewed
Mar 3, 2025
sbfnk
reviewed
Mar 3, 2025
Closed
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
…n>: <description>]
|
Although this PR wasn't targeting #27, the suggestions and changes have tackled some of the points mentioned in that issue. I've left a comment in #27 that only Thanks for the comments @pearsonca and @sbfnk, let me know if there's anything else to the changed, if not, I'm happy for this to be merged when you're ready. |
pearsonca
approved these changes
Mar 3, 2025
sbfnk
approved these changes
Mar 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR addresses #58 & #67.
I've removed duplicated documentation of function arguments and used
@inheritParamsinstead.outbreak_model.Ris the main function that documents arguments and other functions that have the same arguments inherit from there.I've added
@returndocumentation to exported functions that were previously missing it.Issue #27 could also have been addressed in this PR, but as I'm still getting familiar with the codebase I didn't have many improvements on the general function documentation for now, and will address this in a subsequent PR.