Skip to content

[Doc] A fix to inconsistent ticks in Base module #2734

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

[Doc] A fix to inconsistent ticks in Base module #2734

wants to merge 9 commits into from
+132 −116

Conversation

Ahmed-Zahran02
Copy link

Reference Issues/PRs

Fixes #809

What does this implement/fix? Explain your changes.

This PR fixes the inconsistent use of double tick quotes in docstring #809 In the base module i fixed all the misusage of tick quotes.

Does your contribution introduce a new dependency? If yes, which one?

No

Any other comments?

No

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Apr 7, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].

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

@Ahmed-Zahran02
Copy link
Author

@MatthewMiddlehurst

MatthewMiddlehurst
MatthewMiddlehurst reviewed Apr 11, 2025
View reviewed changes
Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the docs so make sure your changes render correctly. There are quite a few with only one `, which may not be as you intended.

aeon/base/_base.py Outdated
Comment on lines 24 to 33
- reset estimator to post-init - ``reset(keep)``
- clone stimator (copy) - ``clone(random_state)``
- inspect tags (class method) - ``get_class_tags()``
- inspect tags (one tag, class) - ``get_class_tag(tag_name, tag_value_default
, raise_error)``
- inspect tags (all) - ``get_tags()``
- inspect tags (one tag) - ``get_tag(tag_name, tag_value_default
, raise_error)``
- setting dynamic tags - ``set_tags(**tag_dict)``
- get fitted parameters - ``get_fitted_params(deep)``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the previous indentation please

aeon/base/_base.py Outdated
@@ -17,23 +17,24 @@

class BaseAeonEstimator(BaseEstimator, ABC):
"""
Base class for defining estimators in aeon.
Base class for defining estimators in ``aeon``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious, do other packages i.e. scikit-learn do this for their package name?

aeon/base/_base.py Outdated

All estimators have the attribute:

- fitted state flag - is_fitted
- fitted state flag - `is_fitted`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not code style?

aeon/base/_base.py Outdated
@@ -433,13 +436,13 @@ def __sklearn_tags__(self):
return sklearn_tags

def _validate_data(self, **kwargs):
"""Sklearn data validation."""
"""``Sklearn`` data validation."""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sklearn if this is codestyle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MatthewMiddlehurst MatthewMiddlehurst MatthewMiddlehurst left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Inconsistent double tick quotes in docstrings
2 participants
@Ahmed-Zahran02 @MatthewMiddlehurst