Skip to content

rustdoc: Document markdown module. #131928

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

aDotInTheVoid
Copy link
Member

Rustdoc markdown handling is currently split between:

  • html::markdown, which contains all the meaty login
  • markdown, which is only used for when rustdoc renders a standalone markdown file

Adds module-level doc-comment to markdown, and rename the function so it's clear that it's doing IO (instead of just rendering to a string).

Rustdoc markdown handling is currently split between:

- html::markdown, which contains all the meaty login
- markdown, which is only used for when rustdoc renders a standalone
  markdown file

Adds module-level doc-comment to markdown, and rename the function so
it's clear that it's doing IO (instead of just rendering to a string).
@rustbot
Copy link
Collaborator

rustbot commented Oct 19, 2024

r? @GuillaumeGomez

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

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

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 23, 2024

📌 Commit 3b78956 has been approved by GuillaumeGomez

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-review Status: Awaiting review from the assignee but also interested parties. labels Oct 23, 2024
fmease added a commit to fmease/rust that referenced this pull request Oct 23, 2024
…, r=GuillaumeGomez

rustdoc: Document `markdown` module.

Rustdoc markdown handling is currently split between:

- html::markdown, which contains all the meaty login
- markdown, which is only used for when rustdoc renders a standalone markdown file

Adds module-level doc-comment to markdown, and rename the function so it's clear that it's doing IO (instead of just rendering to a string).
fmease added a commit to fmease/rust that referenced this pull request Oct 23, 2024
…, r=GuillaumeGomez

rustdoc: Document `markdown` module.

Rustdoc markdown handling is currently split between:

- html::markdown, which contains all the meaty login
- markdown, which is only used for when rustdoc renders a standalone markdown file

Adds module-level doc-comment to markdown, and rename the function so it's clear that it's doing IO (instead of just rendering to a string).
fmease added a commit to fmease/rust that referenced this pull request Oct 23, 2024
…, r=GuillaumeGomez

rustdoc: Document `markdown` module.

Rustdoc markdown handling is currently split between:

- html::markdown, which contains all the meaty login
- markdown, which is only used for when rustdoc renders a standalone markdown file

Adds module-level doc-comment to markdown, and rename the function so it's clear that it's doing IO (instead of just rendering to a string).
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 23, 2024
Rollup of 9 pull requests

Successful merges:

 - rust-lang#130991 (Vectorized SliceContains)
 - rust-lang#131928 (rustdoc: Document `markdown` module.)
 - rust-lang#131955 (Set `signext` or `zeroext` for integer arguments on RISC-V and LoongArch64)
 - rust-lang#131979 (Minor tweaks to `compare_impl_item.rs`)
 - rust-lang#132036 (Add a test case for rust-lang#131164)
 - rust-lang#132039 (Specialize `read_exact` and `read_buf_exact` for `VecDeque`)
 - rust-lang#132060 ("innermost", "outermost", "leftmost", and "rightmost" don't need hyphens)
 - rust-lang#132065 (Clarify documentation of `ptr::dangling()` function)
 - rust-lang#132066 (Fix a typo in documentation of `pointer::sub_ptr()`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 8af1851 into rust-lang:master Oct 24, 2024
6 checks passed
@rustbot rustbot added this to the 1.84.0 milestone Oct 24, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 24, 2024
Rollup merge of rust-lang#131928 - aDotInTheVoid:wait-we-support-this, r=GuillaumeGomez

rustdoc: Document `markdown` module.

Rustdoc markdown handling is currently split between:

- html::markdown, which contains all the meaty login
- markdown, which is only used for when rustdoc renders a standalone markdown file

Adds module-level doc-comment to markdown, and rename the function so it's clear that it's doing IO (instead of just rendering to a string).
@aDotInTheVoid aDotInTheVoid deleted the wait-we-support-this branch October 24, 2024 07:05
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants