Skip to content

[docs] Grammar and formatting updates to docstrings#5963

Merged
quasiben merged 2 commits intodask:masterfrom
jameslamb:docs/docstrings
Mar 2, 2020
Merged

[docs] Grammar and formatting updates to docstrings#5963
quasiben merged 2 commits intodask:masterfrom
jameslamb:docs/docstrings

Conversation

@jameslamb
Copy link
Copy Markdown
Member

In this PR, I'd like to propose some minor changes to a few small improvements to docstrings.

This PR contains one grammatical correction and one suggested use of inline code formatting. All other changes are just eliminating excess whitespace...please let me know if you'd like me to revert the whitespace changes.

Thanks for your time and consideration.

Required checks

  • Tests added / passed
  • Passes black dask / flake8 dask

@quasiben
Copy link
Copy Markdown
Member

quasiben commented Mar 2, 2020

Thanks @jameslamb for the contribution. In general, these look great. However, a number of changed include moving from two spaces to one space after a period and I want to check in with other devs about this. Are folks especially opinionated about the two vs one space after a period issue ?

@jameslamb
Copy link
Copy Markdown
Member Author

Thanks @jameslamb for the contribution. In general, these look great. However, a number of changed include moving from two spaces to one space after a period and I want to check in with other devs about this. Are folks especially opinionated about the two vs one space after a period issue ?

No problem! I just assumed those were mistakes, since most docstrings in the project have one space after periods. Let me know, I'm happy to revert those whitespace changes.

@jrbourbeau
Copy link
Copy Markdown
Member

Thanks for the PR @jameslamb! I have no strong opinion on the one vs. two space after a period topic. Likewise I'm in favor of accepting inconsistencies and letting whoever is contributing documentation use whatever convention they prefer.

@jameslamb
Copy link
Copy Markdown
Member Author

Thanks for the PR @jameslamb! I have no strong opinion on the one vs. two space after a period topic. Likewise I'm in favor of accepting inconsistencies and letting whoever is contributing documentation use whatever convention they prefer.

sure! Ok I'll revert the changes then. If you don't consider them mistakes, let's not touch those lines.

@quasiben
Copy link
Copy Markdown
Member

quasiben commented Mar 2, 2020

@jrbourbeau that's a good philosophy on doc edits. I'll use that moving forward

@quasiben
Copy link
Copy Markdown
Member

quasiben commented Mar 2, 2020

Thank you again for the updates @jameslamb and apologies for the back and forth on spaces

@quasiben quasiben merged commit 2b7945e into dask:master Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants