-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Use imperative form in docstrings #60153
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
Conversation
I.e. change "Returns" to "Return" and similar.
|
On another stylistic note, in some places we have "{Check,Determine} if" and in other places we have "{Check,Determine} whether". I would lean towards changing them all to "whether" (which tends to be preferred in formal writing). |
|
If we go down that rabbit hole, one can also wonder about e.g. "Get" versus "Return" ; or "Determine" vs "Check" etc. But I'll leave that to someone else in another PR ;-) |
|
Glad go learn about CheckDocs.jl and I'll look into using it on my own packages. but in the meantime, any objections to this PR? Or can we merge it? |
|
None from me at all — I just thought I'd mention there's a less manual way of checking 🙂 |

I.e. change "Returns" to "Return" and similar.
Progress towards issue #50301