Added docstrings for all exported methods!#546
Closed
anurag-mds wants to merge 7 commits intoJuliaStats:masterfrom
anurag-mds:docs/exported-docstrings
Closed
Added docstrings for all exported methods!#546anurag-mds wants to merge 7 commits intoJuliaStats:masterfrom anurag-mds:docs/exported-docstrings
anurag-mds wants to merge 7 commits intoJuliaStats:masterfrom
anurag-mds:docs/exported-docstrings
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #546 +/- ##
==========================================
+ Coverage 85.44% 85.48% +0.04%
==========================================
Files 11 13 +2
Lines 625 889 +264
==========================================
+ Hits 534 760 +226
- Misses 91 129 +38 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
Due to constant julia formatting and Codecov warnings I am closing this PR to actually see what's happening as this is my first time encountering this thing Really sorry for such a messy PR |
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.
This PR addresses issue #533 by ensuring that all exported methods in TimeSeries.jl have comprehensive docstrings.
The following actions were taken:
Reviewed all exported functions, types, and constants.
Added or improved docstrings for any missing or incomplete documentation.
Followed the existing documentation style for consistency.
Included examples where helpful.
Motivation:
Having complete docstrings for all exported methods improves usability and discoverability for users, making the package easier to use and understand.
Notes:
All existing tests are passing. No change was done to code just documentation-only fixes were done.
Reviewers:
@ValentinKaisermayer @iblislin