Skip to content

[DOC] Fix inconsistent docstring formatting for issue #809 #2716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from

Conversation

an04shu
Copy link

@an04shu an04shu commented Apr 1, 2025

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, and None 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
For developers with write access

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added examples Example notebook related forecasting Forecasting package labels Apr 1, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
I have added the following labels to this PR based on the changes made: [ $\color{#45FD64}{\textsf{examples}}$, $\color{#31FCCD}{\textsf{forecasting}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@an04shu an04shu changed the title Fix inconsistent docstring formatting for issue #809 [DOC] Fix inconsistent docstring formatting for issue #809 Apr 1, 2025
@an04shu an04shu closed this Apr 2, 2025
@an04shu an04shu deleted the fix-docstring-formatting branch April 2, 2025 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Example notebook related forecasting Forecasting package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Inconsistent double tick quotes in docstrings
1 participant