[DOC] Fixed inconsistent backticks in docstrings #809 #2718
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
What does this implement/fix? Explain your changes.
This PR improves the consistency and clarity of docstrings in the
BaseForecaster
class, ensuring compliance with aeon’s documentation standards. The key changes include:fit
,predict
,forecast
) for better clarity.These improvements enhance documentation quality, making it easier for users and contributors to understand and use the
BaseForecaster
class.Does your contribution introduce a new dependency? If yes, which one?
No, this PR does not introduce any new dependencies.
Any other comments?
PR Checklist
For all contributions
✅ I've added myself to the [list of contributors](https://github.com/aeon-toolkit/aeon/blob/main/.all-contributorsrc). Alternatively, I will use the
@all-contributors
bot after the PR is merged.✅ The PR title starts with
[DOC]
, indicating a documentation-related update.For new estimators and functions
✅ Not applicable (no new estimators or functions added).
For developers with write access
✅ Not applicable (no updates to CODEOWNERS).
This description ensures clarity, follows aeon's contribution guidelines, and meets all necessary formatting and documentation standards. Let me know if you need any modifications! 🚀