Skip to content

Added docstrings for all exported methods!#545

Closed
anurag-mds wants to merge 8 commits intoJuliaStats:masterfrom
anurag-mds:doc-fix-branch
Closed

Added docstrings for all exported methods!#545
anurag-mds wants to merge 8 commits intoJuliaStats:masterfrom
anurag-mds:doc-fix-branch

Conversation

@anurag-mds
Copy link
Copy Markdown
Contributor

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

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.58%. Comparing base (3291223) to head (90a0372).
⚠️ Report is 16 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #545      +/-   ##
==========================================
+ Coverage   85.44%   85.58%   +0.14%     
==========================================
  Files          11       13       +2     
  Lines         625      888     +263     
==========================================
+ Hits          534      760     +226     
- Misses         91      128      +37     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@anurag-mds anurag-mds closed this Dec 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants