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

Rustdoc: example of use of assertions #48961

Merged
merged 1 commit into from
Mar 16, 2018

Conversation

Songbird0
Copy link
Contributor

I added this section at the beginning of the file because it seems to be basic information. Let me know if there's someplace more relevant.

See #47945.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 12, 2018
@@ -31,6 +31,17 @@ let x = 5;

There's some subtlety though! Read on for more details.

## Assertions-dedicated macros

Of course, `assert!`, `assert_eq!` and `assert_ne` can be used into your examples as in any Rust source code.
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, i'm not a fan of this phrasing. How about something like this?

Passing or failing a doctest

Like regular unit tests, regular doctests are considered to "pass" if they compile and run without panicking. So if you want to demonstrate that some computation gives a certain result, the assert! family of macros works the same as other Rust code:

let foo = "foo";

assert_eq!(foo, "foo");

This way, if the computation ever returns something different, the code panics and the doctest fails.


Also, be aware that we like to insert hard line breaks into the docs to keep a single line from running longer than 100 characters. You can use the other sections in this file as a guideline.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll replace the changes.

Also, be aware that we like to insert hard line breaks into the docs to keep a single line from running longer than 100 characters. You can use the other sections in this file as a guideline.

Understood.

@QuietMisdreavus
Copy link
Member

Thanks so much! It looks great now. I'll let travis run its course and push this on if it turns green. (Unless @steveklabnik or @GuillaumeGomez have farther comments before then.)

@GuillaumeGomez
Copy link
Member

Nope, looks good to me. But a squash is required here as well. :)

@Songbird0
Copy link
Contributor Author

The squash was performed, here, @GuillaumeGomez.

@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Mar 15, 2018

📌 Commit a48224b has been approved by GuillaumeGomez

@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 Mar 15, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Mar 15, 2018
…ns, r=GuillaumeGomez

Rustdoc: example of use of assertions

I added this section at the beginning of the file because it seems to be basic information. Let me know if there's someplace more relevant.

See rust-lang#47945.
bors added a commit that referenced this pull request Mar 16, 2018
Rollup of 17 pull requests

- Successful merges: #48706, #48875, #48892, #48922, #48957, #48959, #48961, #48965, #49007, #49024, #49042, #49050, #48853, #48990, #49037, #49049, #48972
- Failed merges:
@bors bors merged commit a48224b into rust-lang:master Mar 16, 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.

6 participants