Document Token{Stream,Tree}::Display more thoroughly.
#120220
Merged
Conversation
This file contains 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
To expressly warn against the kind of proc macro implementation that was broken in rust-lang#119875.
rustbot
added
the
S-waiting-on-review
|
I'm not totally set on the wording, and I am happy to hear any suggestions for improvements. |
fmease
reviewed
Jan 22, 2024
| @@ -191,6 +191,14 @@ impl ToString for TokenStream { | |||
| /// Prints the token stream as a string that is supposed to be losslessly convertible back | |||
| /// into the same token stream (modulo spans), except for possibly `TokenTree::Group`s | |||
| /// with `Delimiter::None` delimiters and negative numeric literals. | |||
| /// | |||
| /// Note: the exact form of the output is subject to change, e.g. there might | |||
There was a problem hiding this comment.
You could consider placing the paragraphs inside <div class="warning"></div> (with an empty line between the tags and the content) and remove the leading Note: to make rustdoc render a warning block. This might be too much though.
There was a problem hiding this comment.
I was wondering if there was a better way to mark this paragraph, but I don't see any other use of this class in the library docs. But there are plenty of existing "Note:" examples. So I think I will leave it unchanged.
There was a problem hiding this comment.
Right, that's because warning blocks were added pretty recently and they haven't found much adoption yet. There's one use of them in the rustc docs since I encouraged Nils to make use of them once.
However, I see your point, do however you prefer.
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jan 22, 2024
…cs, r=petrochenkov
Document `Token{Stream,Tree}::Display` more thoroughly.
To expressly warn against the kind of proc macro implementation that was broken in rust-lang#119875.
r? `@petrochenkov`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 22, 2024
…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#119664 (Fix tty detection for msys2's `/dev/ptmx`) - rust-lang#120104 (never_patterns: Count `!` bindings as diverging) - rust-lang#120109 (Move cmath into `sys`) - rust-lang#120143 (Consolidate logic around resolving built-in coroutine trait impls) - rust-lang#120159 (Track `verbose` and `verbose_internals`) - rust-lang#120188 (compiler: update freebsd and netbsd base specs.) - rust-lang#120216 (Fix a `trimmed_def_paths` assertion failure.) - rust-lang#120220 (Document `Token{Stream,Tree}::Display` more thoroughly.) - rust-lang#120233 (Revert stabilization of trait_upcasting feature) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 22, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#119664 (Fix tty detection for msys2's `/dev/ptmx`) - rust-lang#120104 (never_patterns: Count `!` bindings as diverging) - rust-lang#120109 (Move cmath into `sys`) - rust-lang#120143 (Consolidate logic around resolving built-in coroutine trait impls) - rust-lang#120159 (Track `verbose` and `verbose_internals`) - rust-lang#120216 (Fix a `trimmed_def_paths` assertion failure.) - rust-lang#120220 (Document `Token{Stream,Tree}::Display` more thoroughly.) - rust-lang#120233 (Revert stabilization of trait_upcasting feature) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 23, 2024
Rollup merge of rust-lang#120220 - nnethercote:TokenStream-Display-docs, r=petrochenkov Document `Token{Stream,Tree}::Display` more thoroughly. To expressly warn against the kind of proc macro implementation that was broken in rust-lang#119875. r? ``@petrochenkov``
DianQK
pushed a commit
to DianQK/rust
that referenced
this pull request
Jan 23, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#119664 (Fix tty detection for msys2's `/dev/ptmx`) - rust-lang#120104 (never_patterns: Count `!` bindings as diverging) - rust-lang#120109 (Move cmath into `sys`) - rust-lang#120143 (Consolidate logic around resolving built-in coroutine trait impls) - rust-lang#120159 (Track `verbose` and `verbose_internals`) - rust-lang#120216 (Fix a `trimmed_def_paths` assertion failure.) - rust-lang#120220 (Document `Token{Stream,Tree}::Display` more thoroughly.) - rust-lang#120233 (Revert stabilization of trait_upcasting feature) r? `@ghost` `@rustbot` modify labels: rollup
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.
To expressly warn against the kind of proc macro implementation that was broken in #119875.
r? @petrochenkov