-
Notifications
You must be signed in to change notification settings - Fork 13.1k
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
Standardize whether lib descriptions end with a period #9447
Comments
This applies to function/struct/etc descriptions too. |
Visiting for triage. There seems to be 1 ( |
cc me |
Visiting for triaging Still looks pretty inconsistent. Most (if not all) of the descriptions are not sentences, so I would think they should not end in periods |
Discussion and resolution of this would happen in "API comment conventions" rust-lang/rfcs#505 I think. |
Today, these almost all end with a period, and I plan on doing so as I go through the docs. /cc @rust-lang/libs, is that acceptable? Or should I not put one? |
@steveklabnik Consistency is most important. I personally like periods in this context, even for sentence fragments. |
I don't have much of an opinion beyond ensuring we're consistent, whatever's easiest I'm game for :) |
Rustup r? `@ghost` changelog: none
http://static.rust-lang.org/doc/master/std/index.html
The text was updated successfully, but these errors were encountered: