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

[Docs] Typo fix in complexity_dimension() docstring #713

Merged

Conversation

JoseAlanis
Copy link
Contributor

Description

This PR fixes a typo in the docstring of the function complexity_dimension(). The function should return the optimal embedding dimension and not the delay, as stated in the docstring.

Proposed Changes

  • I changed the docstring (line 75).
  • Some changes made by black formatter

Checklist

Here are some things to check before creating the PR. If you encounter any issues, do let us know :)

  • I have read the CONTRIBUTING file.
  • My PR is targetted at the dev branch (and not towards the master branch).
  • I ran the CODE CHECKS on the files I added or modified and fixed the errors.
  • I have added the newly added features to News.rst (if applicable)

Returns optimal value for dimension not for delay.
@welcome
Copy link

welcome bot commented Sep 28, 2022

Thanks for opening this pull request! We'll make sure it's perfect before merging 🤗 force
Make sure to read the contributing guide. Also, if you think that your contribution is worthy of it, you can consider adding yourself to the Contributors list (feel free to ask us if you have any doubts).

@DominiqueMakowski
Copy link
Member

Good catch, thanks!

@DominiqueMakowski DominiqueMakowski changed the title Typo fix in complexity_dimension() docstring [Docs] Typo fix in complexity_dimension() docstring Sep 28, 2022
@DominiqueMakowski DominiqueMakowski merged commit 19e43ac into neuropsychology:dev Sep 28, 2022
@welcome
Copy link

welcome bot commented Sep 28, 2022

landing
Congrats on merging your first pull request! 🎉🍾 We're looking forward to your next one!

@JoseAlanis JoseAlanis deleted the typo_fix_complexitydim branch September 28, 2022 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants