Skip to content

[DOC] Typo correction in getting started guide#1842

Merged
TonyBagnall merged 3 commits intoaeon-toolkit:mainfrom
IRKnyazev:main
Jul 26, 2024
Merged

[DOC] Typo correction in getting started guide#1842
TonyBagnall merged 3 commits intoaeon-toolkit:mainfrom
IRKnyazev:main

Conversation

@IRKnyazev
Copy link
Copy Markdown
Contributor

@IRKnyazev IRKnyazev commented Jul 23, 2024

Reference Issues/PRs

Fixes #1841.

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

No additional dependencies.

Any other comments?

The decision for removing the redundant 'n_timepoints' was supported by Antoine.

@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Jul 23, 2024
@aeon-actions-bot
Copy link
Copy Markdown
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 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

@IRKnyazev
Copy link
Copy Markdown
Contributor Author

I made a contribution to a different issue on the same branch, but I removed that commit so this PR should only involve yesterday's contributions of the two typos in the getting start guide.

@baraline
Copy link
Copy Markdown
Member

baraline commented Jul 24, 2024

Hey ! Thanks for contributing, I think there is a confusion on the n_timepoints thing. We never used m_timepoints (n is short for number of), the second occurrence might be a relicate of the time when we also used n_timestamps. The double occurrence of n_timepoint here must be due to a mass replace of n_timestamps by n_timepoints and can be deleted.

@IRKnyazev
Copy link
Copy Markdown
Contributor Author

Hi @baraline,
thanks for the feedback, I will remove the second occurrence!

Copy link
Copy Markdown
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.

LGTM after the changes

@MatthewMiddlehurst
Copy link
Copy Markdown
Member

It is good to fill out the initial PR as best you can. You can delete template bits if they do not apply. Good practice to link to issue if you can, i.e. "Fixes #1841" which will close that issue on merge.

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] Typo present in getting start guide: Redundant use of 'n_timepoints'

4 participants