Skip to content

Add doc examples for OsStr, OsString. - #40458

Merged
bors merged 6 commits into
rust-lang:masterfrom
frewsxcv:frewsxcv-osstr
Mar 17, 2017
Merged

Add doc examples for OsStr, OsString.#40458
bors merged 6 commits into
rust-lang:masterfrom
frewsxcv:frewsxcv-osstr

Conversation

@frewsxcv

@frewsxcvfrewsxcv commented Mar 12, 2017

Copy link
Copy Markdown
Contributor

No description provided.

GuillaumeGomez
GuillaumeGomez previously requested changes Mar 13, 2017
View reviewed changes

@GuillaumeGomezGuillaumeGomez left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one nit.

Comment threadsrc/libstd/ffi/os_str.rs Outdated

@GuillaumeGomezGuillaumeGomezMar 13, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rust annotation is useless.

@frewsxcvfrewsxcvMar 14, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API documentation conventions don't mention that we have to remove these annotations.

https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md

@GuillaumeGomezGuillaumeGomezMar 14, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the annotations in a lot of places, so please don't add them back.

@frewsxcvfrewsxcvMar 14, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest force push removes them.

I removed the annotations in a lot of places, so please don't add them back.

Sure, but just because you removed the annotations doesn't mean we should enforce this everywhere. Personally, I prefer to leave in the rust annotation.

@GuillaumeGomezGuillaumeGomezMar 14, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth to start an official statement about this with @rust-lang/docs.

@steveklabniksteveklabnikMar 14, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that the RFC stated to not use them more strongly, but apparently it does not.

ollie27
ollie27 reviewed Mar 13, 2017
View reviewed changes
Comment threadsrc/libstd/ffi/os_str.rs Outdated

@ollie27ollie27Mar 13, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reserve_exact -> reserve

@frewsxcvfrewsxcvMar 14, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catches, thanks!

Comment threadsrc/libstd/ffi/os_str.rs Outdated

@ollie27ollie27Mar 13, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reserve -> reserve_exact

@frewsxcv

frewsxcv commented Mar 14, 2017

Copy link
Copy Markdown
ContributorAuthor

Comments have been addressed.

@frewsxcv

frewsxcv commented Mar 14, 2017

Copy link
Copy Markdown
ContributorAuthor

@GuillaumeGomez Everything look good here?

@frewsxcv
frewsxcv dismissed GuillaumeGomez’s stale reviewMarch 14, 2017 22:27

Comments have been addressed.

@bors

bors commented Mar 15, 2017

Copy link
Copy Markdown
Collaborator

☔ The latest upstream changes (presumably #40009) made this pull request unmergeable. Please resolve the merge conflicts.

@GuillaumeGomez

GuillaumeGomez commented Mar 15, 2017

Copy link
Copy Markdown
Member

r=me once conflicts fixed.

@frewsxcv

frewsxcv commented Mar 17, 2017

Copy link
Copy Markdown
ContributorAuthor

@bors r=GuillaumeGomez rollup

@bors

bors commented Mar 17, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit bc6eecd has been approved by GuillaumeGomez

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 17, 2017
@frewsxcv
Rollup merge ofrust-lang#40458- frewsxcv:frewsxcv-osstr, r=Guillaum…
ced41ef
…eGomez
Add doc examples for `OsStr`, `OsString`.
None
@frewsxcvfrewsxcv mentioned this pull request Mar 17, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 17, 2017
@frewsxcv
Rollup merge ofrust-lang#40458- frewsxcv:frewsxcv-osstr, r=Guillaum…
d173aea
…eGomez
Add doc examples for `OsStr`, `OsString`.
None
@frewsxcvfrewsxcv mentioned this pull request Mar 17, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 17, 2017
@frewsxcv
Rollup merge ofrust-lang#40458- frewsxcv:frewsxcv-osstr, r=Guillaum…
695d7ec
…eGomez
Add doc examples for `OsStr`, `OsString`.
None
@frewsxcvfrewsxcv mentioned this pull request Mar 17, 2017
Merged
bors added a commit that referenced this pull request Mar 17, 2017
@bors
Auto merge of#40598- frewsxcv:rollup, r=frewsxcv
a559452
Rollup of 23 pull requests
- Successful merges: #40387, #40433, #40452, #40456, #40457, #40458, #40463, #40466, #40467, #40495, #40496, #40497, #40499, #40500, #40503, #40505, #40512, #40514, #40517, #40520, #40536, #40545, #40586
- Failed merges:
@bors
bors merged commit bc6eecd into rust-lang:masterMar 17, 2017
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez left review comments
+2 more reviewers
@steveklabniksteveklabniksteveklabnik left review comments
@ollie27ollie27ollie27 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@frewsxcv@bors@GuillaumeGomez@steveklabnik@ollie27