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] Converging towards numpy doc standards V2 - issue #1540 #1863

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

IRKnyazev
Copy link
Contributor

@IRKnyazev IRKnyazev commented Jul 29, 2024

Reference Issues/PRs

Fixes #1540

What does this implement/fix? Explain your changes.

Docstrings weren't following numpy style guide. Corrected the sections titled Arguments to be Parameters. In the base.y there is a use of Arguments however this is correct, classes can use a section with this title.

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

No.

Any other comments?

I found the first instance as described by @aadya940 then used the case-sensitive search in vscode for the remaining inconsistencies.
This is a continuation of an earlier PR for which not all changes were accepted.

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.
  • 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.

@aeon-actions-bot aeon-actions-bot bot added documentation Improvements or additions to documentation forecasting Forecasting package networks Networks package labels Jul 29, 2024
@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}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#31FCCD}{\textsf{forecasting}}$, $\color{#379E11}{\textsf{networks}}$ ]. 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 all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Push an empty commit to re-run CI checks

Copy link
Contributor

@TonyBagnall TonyBagnall left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@TonyBagnall
Copy link
Contributor

@all-contributors add @IRKnyazev for docs

Copy link
Contributor

@TonyBagnall

@IRKnyazev already contributed before to doc

@TonyBagnall TonyBagnall merged commit e0eb924 into aeon-toolkit:main Aug 1, 2024
15 checks passed
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 forecasting Forecasting package networks Networks package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Mix Docstring styles in aeon.
2 participants