Revise graphviz doc-comments to avoid generating files from rustdoc runs. #13976
Conversation
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
| # pub fn main() { use std::io::MemWriter; render_to(&mut MemWriter::new()) } | ||
| ``` | ||
|
|
||
| ```ignore |
There was a problem hiding this comment.
This could be weakened to no_run (IIRC) so that it's still compiled.
There was a problem hiding this comment.
true; I'll do that. (And in fact, I think doing this caught a bug...)
|
r=me with a squash |
…oc runs. Fix rust-lang#13965. There is a dance here between the `main` that actually runs versus the `main` that is printed in the output documentation. We don't run the latter `main`, but we do at least compile (and thus type-check) it. It is still the responsibility of the documenter to ensure that the signatures of `fn render` are kept in sync across the blocks.
bors
added a commit
that referenced
this pull request
May 8, 2014
Fix #13965. This commit adopts the second strategy I outlined in #13965, where the bulk of the code is still "smoke tested" (in the sense that rustdoc attempts to run it, sending all of the generated output into a locally allocated `MemWriter`). The part of the code that is ignored (but included in the presentation) is isolated to a three-line `main` function that invokes the core rendering routine. In the generated rustdoc output, this leads to a small break between the two code blocks, but I do not think this is a large issue.
bors
pushed a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 28, 2025
…ust-lang#13976) Checking it only in the merge queue leads to deferred failures once the decision to merge has been taken already. - [X] Testing first without changelog line - [x] Now that that has failed, adding the changelog line and force-pushing changelog: none
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #13965.
This commit adopts the second strategy I outlined in #13965, where the bulk of the code is still "smoke tested" (in the sense that rustdoc attempts to run it, sending all of the generated output into a locally allocated
MemWriter). The part of the code that is ignored (but included in the presentation) is isolated to a three-linemainfunction that invokes the core rendering routine.In the generated rustdoc output, this leads to a small break between the two code blocks, but I do not think this is a large issue.