[DOC] Fix inconsistent docstring formatting for issue #809 #2716
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.
Reference Issues/PRs
Fixes #809. This PR addresses inconsistencies in docstring formatting in the
aeon.forecasting
module.What does this implement/fix? Explain your changes.
This pull request resolves an issue with inconsistent use of single and double ticks for code references within docstrings across several files. The issue caused references to code elements like
int
,RandomState
, andNone
to be inconsistently formatted, leading to confusion in the documentation. All references have now been standardized to use double ticks for consistency and clarity in the documentation. The affected files are:aeon/forecasting/_dummy.py
aeon/forecasting/_ets.py
aeon/forecasting/_regression.py
aeon/forecasting/base.py
The changes improve the readability and accuracy of the API documentation.
Does your contribution introduce a new dependency? If yes, which one?
No new dependencies
Any other comments?
This PR solely focuses on fixing the formatting issues in the docstrings. No functionality has been changed.
PR checklist
For all contributions
For new estimators and functions
__maintainer__
at the top of relevant files and want to be contacted regarding its maintenance.For developers with write access