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

Update rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function #51183

Merged
merged 2 commits into from Jun 5, 2018
Merged

Update rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function #51183

merged 2 commits into from Jun 5, 2018

Conversation

teiesti
Copy link
Contributor

@teiesti teiesti commented May 29, 2018

Closes #50721.

I suggest that someone double-checks my English since I am not a native speaker.

r? @steveklabnik

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 29, 2018
Copy link
Member

@steveklabnik steveklabnik left a comment

Choose a reason for hiding this comment

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

This looks great, but I have one tiny grammar thing. Thank you so much for doing this!


## Using `?` in doc tests

A complete error handling is often not useful in your example, as it would add
Copy link
Member

Choose a reason for hiding this comment

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

I would change this slightly. This isn't wrong, but sounds a bit strange.

In your examples, handling all errors is not often useful, as it would add

@pietroalbini
Copy link
Member

Ping from triage @steveklabnik! This PR needs your review.

@steveklabnik
Copy link
Member

Thank you!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jun 4, 2018

📌 Commit efa8de8 has been approved by steveklabnik

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 4, 2018
@bors
Copy link
Contributor

bors commented Jun 5, 2018

🔒 Merge conflict

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jun 5, 2018
@pietroalbini
Copy link
Member

@teiesti can you please rebase this PR on top of the latest master?

@teiesti
Copy link
Contributor Author

teiesti commented Jun 5, 2018

Done.

@pietroalbini
Copy link
Member

@steveklabnik this should be approved again.

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jun 5, 2018

📌 Commit 089da06 has been approved by steveklabnik

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 5, 2018
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Jun 5, 2018
…=steveklabnik

Update rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function

Closes rust-lang#50721.

I suggest that someone double-checks my English since I am not a native speaker.

r? @steveklabnik
bors added a commit that referenced this pull request Jun 5, 2018
Rollup of 7 pull requests

Successful merges:

 - #50852 (Add doc comment to hiding portions of code example)
 - #51183 (Update rustdoc book to suggest using Termination trait instead of hidden ‘foo’ function)
 - #51255 (Fix confusing error message for sub_instant)
 - #51256 (Fix crate-name option in rustdoc)
 - #51308 (Check array indices in constant propagation)
 - #51343 (test: Ignore some problematic tests on sparc and sparc64)
 - #51358 (Tests that #39963 is fixed on MIR borrowck)

Failed merges:
@bors bors merged commit 089da06 into rust-lang:master Jun 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants