Skip to content
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

[DOC]Fixed docstring ticks in documentation #2506

Closed
wants to merge 3 commits into from

Conversation

iaadarsh23
Copy link

This pull request addresses the issue of incorrect docstring ticks in the documentation. The changes include:

Corrected single backticks to triple backticks for code blocks to ensure proper formatting.
Updated the formatting for the following parameters to improve readability:
random_state: int or RandomState, default=None
Random seed or RandomState object.
n_jobs: int, default=1
The number of jobs to run in parallel. -1 means using all processors.
n_cases_: int
Number of train instances in data passed to fit.
Reference Issues/PRs:
Fixes #2434

What does this implement/fix? Explain your changes.
This PR corrects the docstring formatting to ensure that code blocks are displayed correctly in the documentation. The changes improve the overall readability and consistency of the docstrings.

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

Any other comments?

Ensure that the formatting aligns with the project's documentation guidelines.
Reviewers, please verify the updated docstrings for accuracy.
PR checklist
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.

View the pull request

@contri

@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Jan 19, 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

@TonyBagnall
Copy link
Contributor

this PR only adds you as a contributor?

@MatthewMiddlehurst
Copy link
Member

Closing for now. Feel free to push a reopen if you are working on content still.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Fitting MultiRocketHydraClassifier with class_weight="balanced_subsample" gives an error
3 participants