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.

Sign up for GitHub

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

Jump to bottom

Fix footnote handling in rustdoc #120443

Merged
merged 2 commits into from
Jan 30, 2024
Merged

Fix footnote handling in rustdoc #120443

merged 2 commits into from
Jan 30, 2024

Conversation

GuillaumeGomez
Copy link
Member

Fixes #100638.

You can now declare footnotes like this:

//! Reference to footnotes A[^1], B[^2] and C[^3].
//!
//! [^1]: Footnote A.
//! [^2]: Footnote B.
//! [^3]: Footnote C.

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 28, 2024
@rustbot
Copy link
Collaborator

rustbot commented Jan 28, 2024

These commits modify the Cargo.lock file. Unintentional changes to Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

@GuillaumeGomez GuillaumeGomez force-pushed the footnote-def-improvement branch from aa71c7c to dad6802 Compare January 28, 2024 13:38
@GuillaumeGomez
Copy link
Member Author

Applied @fmease suggestion. :)

@fmease
Copy link
Member

fmease commented Jan 28, 2024

Cool!
r? fmease @bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 28, 2024

📌 Commit dad6802 has been approved by fmease

It is now in the queue for this repository.

@rustbot rustbot assigned fmease and unassigned notriddle Jan 28, 2024
@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 Jan 28, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 28, 2024
@matthiaskrgr
Rollup merge of rust-lang#120443 - GuillaumeGomez:footnote-def-improv…
1ff326d 
…ement, r=fmease

Fixes footnote handling in rustdoc

Fixes rust-lang#100638.

You can now declare footnotes like this:

```rust
//! Reference to footnotes A[^1], B[^2] and C[^3].
//!
//! [^1]: Footnote A.
//! [^2]: Footnote B.
//! [^3]: Footnote C.
```

r? `@notriddle`
@matthiaskrgr matthiaskrgr mentioned this pull request Jan 28, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 28, 2024
@bors
Auto merge of rust-lang#120448 - matthiaskrgr:rollup-j30dzmw, r=matth…
4c57de4 
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#116677 (References refer to allocated objects)
 - rust-lang#118533 (Suppress unhelpful diagnostics for unresolved top level attributes)
 - rust-lang#119991 (Reject infinitely-sized reads from io::Repeat)
 - rust-lang#120232 (Add support for custom JSON targets when using build-std.)
 - rust-lang#120358 (Bump Fuchsia, build tests, and use 8 core bots)
 - rust-lang#120424 (raw pointer metadata API: data address -> data pointer)
 - rust-lang#120434 (Revert outdated version of "Add the wasm32-wasi-preview2 target")
 - rust-lang#120443 (Fixes footnote handling in rustdoc)

r? `@ghost`
`@rustbot` modify labels: rollup
fmease added a commit to fmease/rust that referenced this pull request Jan 29, 2024
@fmease
Rollup merge of rust-lang#120443 - GuillaumeGomez:footnote-def-improv…
83b3958 
…ement, r=fmease

Fixes footnote handling in rustdoc

Fixes rust-lang#100638.

You can now declare footnotes like this:

```rust
//! Reference to footnotes A[^1], B[^2] and C[^3].
//!
//! [^1]: Footnote A.
//! [^2]: Footnote B.
//! [^3]: Footnote C.
```

r? ``@notriddle``
@fmease fmease mentioned this pull request Jan 29, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 29, 2024
@bors
Auto merge of rust-lang#120461 - fmease:rollup-30y3cyy, r=fmease
9b7e09b 
Rollup of 10 pull requests

Successful merges:

 - rust-lang#116677 (References refer to allocated objects)
 - rust-lang#119991 (Reject infinitely-sized reads from io::Repeat)
 - rust-lang#120266 (Improve documentation for [A]Rc::into_inner)
 - rust-lang#120376 (Update codegen test for LLVM 18)
 - rust-lang#120402 (Make the coroutine def id of an async closure the child of the closure def id)
 - rust-lang#120424 (raw pointer metadata API: data address -> data pointer)
 - rust-lang#120425 (Remove unnecessary unit returns in query declarations)
 - rust-lang#120428 (hir: Two preparatory changes for rust-lang#120206)
 - rust-lang#120434 (Revert outdated version of "Add the wasm32-wasi-preview2 target")
 - rust-lang#120443 (Fixes footnote handling in rustdoc)

r? `@ghost`
`@rustbot` modify labels: rollup
@GuillaumeGomez
Copy link
Member Author

Version 0.9.5 of pulldown-cmark has been yanked so it'll fail CI. Updating.

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jan 29, 2024
@GuillaumeGomez GuillaumeGomez force-pushed the footnote-def-improvement branch from dad6802 to 1e60cc9 Compare January 29, 2024 13:14
@GuillaumeGomez
Copy link
Member Author

@bors r=fmease

@bors
Copy link
Contributor

bors commented Jan 29, 2024

📌 Commit 1e60cc9 has been approved by fmease

It is now in the queue for this repository.

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 29, 2024
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jan 30, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 30, 2024
@bors
Auto merge of rust-lang#120491 - GuillaumeGomez:rollup-94wj681, r=Gui…
5ad7454 
…llaumeGomez

Rollup of 18 pull requests

Successful merges:

 - rust-lang#119123 (Add triagebot mentions entry for simd intrinsics)
 - rust-lang#119991 (Reject infinitely-sized reads from io::Repeat)
 - rust-lang#120172 (bootstrap: add more unit tests)
 - rust-lang#120250 (rustdoc: Prevent JS injection from localStorage)
 - rust-lang#120376 (Update codegen test for LLVM 18)
 - rust-lang#120387 (interpret/memory: fix safety comment for large array memset optimization)
 - rust-lang#120400 (Bound errors span label cleanup)
 - rust-lang#120402 (Make the coroutine def id of an async closure the child of the closure def id)
 - rust-lang#120403 (Add instructions of how to use pre-vendored 'rustc-src')
 - rust-lang#120424 (raw pointer metadata API: data address -> data pointer)
 - rust-lang#120425 (Remove unnecessary unit returns in query declarations)
 - rust-lang#120439 (Move UI issue tests to subdirectories)
 - rust-lang#120443 (Fixes footnote handling in rustdoc)
 - rust-lang#120452 (std: Update documentation of seek_write on Windows)
 - rust-lang#120460 (Be more careful about interpreting a label/lifetime as a mistyped char literal.)
 - rust-lang#120464 (Add matthewjasper to some review groups)
 - rust-lang#120467 (Update books)
 - rust-lang#120488 (Diagnostic lifetimes cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit f35504d into rust-lang:master Jan 30, 2024
11 checks passed
@rustbot rustbot added this to the 1.77.0 milestone Jan 30, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jan 30, 2024
@rust-timer
Unrolled build for rust-lang#120443
2922ca6 
Rollup merge of rust-lang#120443 - GuillaumeGomez:footnote-def-improvement, r=fmease

Fixes footnote handling in rustdoc

Fixes rust-lang#100638.

You can now declare footnotes like this:

```rust
//! Reference to footnotes A[^1], B[^2] and C[^3].
//!
//! [^1]: Footnote A.
//! [^2]: Footnote B.
//! [^3]: Footnote C.
```

r? `@notriddle`
@GuillaumeGomez GuillaumeGomez deleted the footnote-def-improvement branch January 30, 2024 15:56
@GuillaumeGomez GuillaumeGomez changed the title Fixes footnote handling in rustdoc Fix footnote handling in rustdoc Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fmease fmease fmease approved these changes

Assignees

@fmease fmease

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.77.0
Development

Successfully merging this pull request may close these issues.

Footnotes are squished together by rustdoc when there's no empty line between them
5 participants
@GuillaumeGomez @rustbot @fmease @bors @notriddle