Skip to content
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

Closed
jruderman opened this issue Sep 24, 2013 · 8 comments
Closed

Standardize whether lib descriptions end with a period #9447

jruderman opened this issue Sep 24, 2013 · 8 comments

Comments

@jruderman
Copy link
Contributor

http://static.rust-lang.org/doc/master/std/index.html

str: String manipulation
task: Task management.
@huonw
Copy link
Member

huonw commented Sep 24, 2013

This applies to function/struct/etc descriptions too.

@flaper87
Copy link
Contributor

flaper87 commented Mar 3, 2014

Visiting for triage.

There seems to be 1 (os) lib with a trailing dot but many inconsistencies for functions and struct descriptions. I agree this should be applied everywhere. FWIW, I think the dot is not needed

@aturon aturon added the A-libs label Jun 3, 2014
@aturon
Copy link
Member

aturon commented Jun 3, 2014

cc me

@frewsxcv
Copy link
Member

frewsxcv commented Feb 3, 2015

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

@bluss
Copy link
Member

bluss commented Feb 3, 2015

Discussion and resolution of this would happen in "API comment conventions" rust-lang/rfcs#505 I think.

@steveklabnik
Copy link
Member

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?

@aturon
Copy link
Member

aturon commented Mar 4, 2016

@steveklabnik Consistency is most important. I personally like periods in this context, even for sentence fragments.

@alexcrichton
Copy link
Member

I don't have much of an opinion beyond ensuring we're consistent, whatever's easiest I'm game for :)

steveklabnik added a commit to steveklabnik/rust that referenced this issue Mar 4, 2016
bors added a commit that referenced this issue Mar 7, 2016
flip1995 pushed a commit to flip1995/rust that referenced this issue Sep 9, 2022
Rustup

r? `@ghost`

changelog: none
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

No branches or pull requests

8 participants