rustdoc: Only hide lines starting with # in rust code blocks
#105539
Merged
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
rustbot
added
S-waiting-on-review
|
I agree we should not hide # lines for non rust blocks. |
|
I agree that we should only hide should render as # Headerwhereas currently I think it would render as nothing? EDIT: Yep, I just checked, and it renders as an empty code block. That seems like definitely unintended behavior. |
|
That’s four of us. |
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
|
UPDATE: This is actually a stable-to-stable regression: #105527 (comment) |
GuillaumeGomez
added
the
beta-nominated
|
Well, better late than never for an old fix. I added a "beta nominated" label so we can at least have this fix available one version sooner. |
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Dec 11, 2022
…ines-non-rust, r=notriddle rustdoc: Only hide lines starting with `#` in rust code blocks Fixes rust-lang#105527. So before approving, this is a big question: in rust code blocks, in a line starts with a `#`, we hide it in the output. However, should we do the same for non-rust code blocks too? I think it's a bit problematic to do it because `#` can be used for many things but I prefer to check first with everyone (might also be worth updating documentation too). cc `@rust-lang/rustdoc` r? `@notriddle`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 11, 2022
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#105411 (Introduce `with_forced_trimmed_paths`) - rust-lang#105532 (Document behaviour of `--remap-path-prefix` with several matches) - rust-lang#105537 (compiler: remove unnecessary imports and qualified paths) - rust-lang#105539 (rustdoc: Only hide lines starting with `#` in rust code blocks ) - rust-lang#105546 (Add some regression tests for rust-lang#44454) - rust-lang#105547 (Add regression test for rust-lang#104582) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Dec 11, 2022
…tag-prep-line, r=notriddle Extend rustdoc hashtag prepended line test Follow-up of rust-lang#105539. This case wasn't checked so better add it. r? `@notriddle`
pietroalbini
added
the
beta-accepted
|
Approved for backport in https://rust-lang.zulipchat.com/#narrow/stream/241545-t-release/topic/1.2E66.2E0/near/315377940. Note: the |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 12, 2022
…troalbini [stable] Prepare 1.66.0 release This PR prepares the artifacts for the 1.66.0 release. The following PRs have been backported: * rust-lang#104782 * rust-lang#105023 * rust-lang#104558 * rust-lang#104610 * rust-lang#103989 * rust-lang#104650 * rust-lang#105539 * rust-lang#105477 r? `@ghost`
Mark-Simulacrum
removed
the
beta-nominated
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 27, 2022
…mulacrum [beta] backport rollup * Revert "Replace usage of ResumeTy in async lowering with Context" rust-lang#105915 * Don't copy symbols from dylibs with -Zdylib-lto rust-lang#105800 * rustdoc: Only hide lines starting with # in rust code blocks rust-lang#105539 * Mangle "main" as "__main_void" on wasm32-wasi rust-lang#105468 r? `@ghost`
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Fixes #105527.
So before approving, this is a big question: in rust code blocks, in a line starts with a
#, we hide it in the output. However, should we do the same for non-rust code blocks too? I think it's a bit problematic to do it because#can be used for many things but I prefer to check first with everyone (might also be worth updating documentation too).cc @rust-lang/rustdoc
r? @notriddle