Skip to content

docstrings: typos, clarity #41845

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

Merged
merged 1 commit into from
Jun 8, 2021
Merged

docstrings: typos, clarity #41845

merged 1 commit into from
Jun 8, 2021

Conversation

stragu
Copy link
Contributor

@stragu stragu commented Jun 7, 2021

Minor changes only in docstrings: capitalisation, hyphenation, "indexes" -> "indices", typos.

  • tests added / passed
  • Ensure all linting tests pass, see here for how to run them
  • whatsnew entry

Apologies for not testing, as the changes are minor and only affect docstrings.
No whatsnew entry either because minor.

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

both spellings are acceptable https://grammarist.com/usage/indexes-indices/

@gfyoung gfyoung added the Docs label Jun 7, 2021
@mzeitlin11
Copy link
Member

both spellings are acceptable https://grammarist.com/usage/indexes-indices/

Not sure if distinction is necessary, but from a pandas perspective I like the idea of

  • Indexes: Multiple Index objects
  • Indices: Values used to index into something

@simonjayhawkins simonjayhawkins added the Closing Candidate May be closeable, needs more eyeballs label Jun 7, 2021
@stragu stragu changed the title docstrings: typos, consistence, clarity docstrings: typos, clarity Jun 8, 2021
Minor changes only in docstrings
@stragu
Copy link
Contributor Author

stragu commented Jun 8, 2021

Thank you both for your comments. I amended the commit to not touch indices vs indexes.

@simonjayhawkins simonjayhawkins removed the Closing Candidate May be closeable, needs more eyeballs label Jun 8, 2021
@simonjayhawkins simonjayhawkins added this to the 1.3 milestone Jun 8, 2021
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @stragu

@simonjayhawkins simonjayhawkins merged commit a76132e into pandas-dev:master Jun 8, 2021
JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Jul 3, 2021
Minor changes only in docstrings
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.

5 participants