Merged
Conversation
8ba42d7 to
61afcee
Compare
eddyp
reviewed
Dec 3, 2020
Contributor
|
Thanks for doing this step by step, it is really cool to see what has to change each time. |
…the diffs There are a few output files that have more than one test binaries; make their hashes be the same because I'm too tired to figure out how to capture and replace multiple different hashes.
7dabd55 to
45c58f9
Compare
The reasons we needed empty `fn main() {}`s were twofold:
- Avoid confusing people when they click the "expand" button on the code
listing and see the auto-main wrapping
- Avoid failing doctests when running `mdbook test` that don't work when
rustdoc wraps a code listing in main
I think I have a solution that mostly solves these cases.
I don't know why this didn't occur to me before. Here's my current
thinking in case these assumptions turn out to be wrong:
There are a [few things that tell mdbook to disable the
main-wrapping][mdbook], and I hadn't noticed one of them until now: if
you annotate a code block with `noplayground`, it won't add a `main`
around it (and it also won't have the "play" button in the upper right
that runs the block and inserts the result into the page).
So instead of putting an empty `fn main() {}` at the bottom of
src/lib.rs files that doesn't make sense, annotate those listings with
`noplayground`. I don't think anyone will miss the play button anyway
because:
- The play button doesn't run tests, so there wasn't any output for
these examples anyway
- If an example doesn't compile, we have it marked `ignore` so that it
doesn't make the tests fail, and `ignore` also disables the play button,
so there isn't a way to see compiler errors either
In most of these cases, `mdbook test` that runs these as doctests will
still wrap these in main, but the tests still pass.
There are some cases, mostly around modules and using `crate::` that
won't pass as doctests when wrapped in main. For those, I've annotated
them with the [undocumented][] [`test_harness`][] attribute that apparently
I was using at some point and then [stopped using][] and now I've
decided to use again, but maybe send in a PR to rust-lang/rust to
change the name to `no_main` and document it or something. In any case,
that shouldn't affect readers at all.
[mdbook]: https://github.com/rust-lang/mdBook/blob/d0deee90b04068ed949f524bb682a47fa26f2218/src/renderer/html_handlebars/hbs_renderer.rs#L805-L808
[undocumented]: rust-lang/rust#42288 (comment)
[`test_harness`]: https://github.com/rust-lang/rust/blob/220352781c2585f0efb07ab0e758b136514de5b8/src/librustdoc/doctest.rs#L252
[stopped using]: #1233 (comment)
I was trying to reuse too much; we don't want the `take(2)` to be part of the final code, but we do want it to be in the listing for the example where we shut down gracefully after 2 requests.
45c58f9 to
322899b
Compare
Member
Author
|
Ok @steveklabnik I think this is ready and I do want you to review it... In the second-to-last commit, I think I have a solution for the empty |
steveklabnik
approved these changes
Dec 9, 2020
Contributor
steveklabnik
left a comment
There was a problem hiding this comment.
This looks great to me, and I agree with your long commit message :) Nice work!
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Dec 22, 2020
Update books ## nomicon 2 commits in d8383b65f7948c2ca19191b3b4bd709b403aaf45..a5a48441d411f61556b57d762b03d6874afe575d 2020-11-22 10:24:42 -0500 to 2020-12-06 10:39:41 +0900 - Update atomics.md (rust-lang/nomicon#249) - Rename `AllocRef` to `Allocator` and `(de)alloc` to `(de)allocate` (rust-lang/nomicon#248) ## reference 2 commits in a8afdca5d0715b2257b6f8b9a032fd4dd7dae855..b278478b766178491a8b6f67afa4bcd6b64d977a 2020-11-30 06:44:46 -0800 to 2020-12-21 18:18:03 -0800 - Update unions for safe ManuallyDrop assignment. (rust-lang/reference#912) - Removing ambiguity in type-layout.md (rust-lang/reference#911) ## book 25 commits in a190438d77d28041f24da4f6592e287fab073a61..5bb44f8b5b0aa105c8b22602e9b18800484afa21 2020-11-16 10:44:08 -0600 to 2020-12-18 20:07:31 -0500 - Make some further edits to rust-lang/book#2447 - Merge remote-tracking branch 'origin/pr/2447' - Remove copied and dangling link brackets - Merge remote-tracking branch 'origin/pr/2359' - Override toolchain to nightly for run lints action. (rust-lang/book#2528) - Remove an uneeded 'static lifetime (rust-lang/book#1752) - Fixes rust-lang/book#2330. Clarify why the lock is held too long - Update paragraph about rustfmt in Chapter 1.2 (rust-lang/book#2304) - Clarify language around further from rust-lang/book#2418 - Merge remote-tracking branch 'origin/pr/2418' - Merge remote-tracking branch 'origin/pr/2475' - Add some further edits to rust-lang/book#2433 - Merge remote-tracking branch 'origin/pr/2433' - Note all the method families to handle integer overflow - Merge remote-tracking branch 'origin/pr/2405' - Fix rust-lang/book#1855 - incorporate new reference cycle diagram - Make some further edits to the changes in rust-lang/book#1886 - Merge remote-tracking branch 'origin/pr/1886' - Make some further edits to rust-lang/book#1998 - Merge remote-tracking branch 'origin/pr/1998' - Update Rust version and output (rust-lang/book#2518) - Fix typo, regarding privileged ports being up to 1023 instead of 1024 (rust-lang/book#2509) - Change "appendixes" to "appendices" in intro. (rust-lang/book#2498) - Update 16-11 to use method call expression for `clone` (rust-lang/book#2511) - Correct chapter 20 final listing (rust-lang/book#2516) ## rust-by-example 7 commits in 236c734a2cb323541b3394f98682cb981b9ec086..1cce0737d6a7d3ceafb139b4a206861fb1dcb2ab 2020-11-30 14:05:49 -0300 to 2020-12-21 17:36:29 -0300 - Add book.description in book.toml (rust-lang/rust-by-example#1397) - Simplify the call of filter_map (rust-lang/rust-by-example#1396) - Update README.md (rust-lang/rust-by-example#1382) - Add missing main function in static life time example. (rust-lang/rust-by-example#1383) - Clarify first matching arm and all possible values (rust-lang/rust-by-example#1395) - Clarify distinction between for iter and into_iter (rust-lang/rust-by-example#1394) - Drop extern crate (rust-lang/rust-by-example#1393)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Just getting this running on CI... I am going to go all the way to latest stable, just want to do one version at a time to better understand what's causing changes.