Added docstrings to exported functions!

[anurag-mds]

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

[anurag-mds]

@ValentinKaisermayer and @iblislin
When you have time, I’d appreciate a review. This PR is documentation-only and addresses #533.

[ValentinKaisermayer]

LGTM, just two minor comments.

[codecov-commenter]

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #547      +/-   ##
==========================================
+ Coverage   85.44%   85.45%   +0.01%     
==========================================
  Files          11       13       +2     
  Lines         625      887     +262     
==========================================
+ Hits          534      758     +224     
- Misses         91      129      +38     

☔ 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]

@ValentinKaisermayer It's done kindly review it and if there are any more changes to notice and fix then please do let me know!

[iblislin]

maybe some of the docstring could be shared in the doc/?
I'm fine to merge this PR first, then we can work on putting/sharing them in doc/

[iblislin]

Thanks for your contributions.

[anurag-mds]

Thank you @iblislin
I am currently doing what you said i.e. sharing/putting them inside doc directory

[ValentinKaisermayer]

Shouldn't Documenter.jl put them there automatically?

[iblislin]

Shouldn't Documenter.jl put them there automatically?

well, no. since there aren't any docstrings before, they aren't included in doc/.

[ValentinKaisermayer]

Shouldn't Documenter.jl put them there automatically?

well, no. since there aren't any docstrings before, they aren't included in doc/.

Maybe we should add an API section like this

# API Documentation
```@autodocs
Modules = [TimeSeries]