[docs] Grammar and formatting updates to docstrings#5963
[docs] Grammar and formatting updates to docstrings#5963quasiben merged 2 commits intodask:masterfrom jameslamb:docs/docstrings
Conversation
|
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. |
|
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. |
|
@jrbourbeau that's a good philosophy on doc edits. I'll use that moving forward |
|
Thank you again for the updates @jameslamb and apologies for the back and forth on spaces |
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
black dask/flake8 dask