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

rustdoc: some nested lists are rendered incorrectly #92971

Closed
lo48576 opened this issue Jan 16, 2022 · 8 comments · Fixed by #93012
Closed

rustdoc: some nested lists are rendered incorrectly #92971

lo48576 opened this issue Jan 16, 2022 · 8 comments · Fixed by #93012
Assignees
@GuillaumeGomez
Labels
C-bug Category: This is a bug. P-high High priority regression-from-stable-to-beta Performance or correctness regression from stable to beta. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Milestone
1.59.0

Comments

@lo48576
Copy link
Contributor

lo48576 commented Jan 16, 2022

Summary

Nested markdown lists as below are not rendered as nested lists, but as single-level lists.

Works as expected:

  • stable (cargo 1.58.0 (7f08ace4f 2021-11-24), rustdoc 1.58.0 (02072b482 2022-01-11))
  • beta (cargo 1.58.0-beta (7f08ace4f 2021-11-24), rustdoc 1.58.0-beta.3 (4aa9d237c 2022-01-08))

Produces unintended output:

  • nightly (cargo 1.60.0-nightly (358e79fe5 2022-01-04), rustdoc 1.60.0-nightly (1bd4fdc94 2022-01-12))

Initially reported at rust-lang/docs.rs#1594.

Source input

//! * foo
//!     + bar
//!     + baz

Expected output

  • foo
    • bar
    • baz

With cargo doc (with stable toolchain):
screenshot-2022-01-17-011919+0900

Actual output

  • foo + bar + baz

With cargo +nightly doc with nightly toolchain:
screenshot-2022-01-17-011924+0900
@lo48576 lo48576 added the C-bug Category: This is a bug. label Jan 16, 2022
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 16, 2022
@GuillaumeGomez
Copy link
Member

I need to confirm if it comes from rustdoc or pulldown-cmark. I'll try to fix it in the next days.

@GuillaumeGomez GuillaumeGomez self-assigned this Jan 16, 2022
@ehuss
Copy link
Contributor

ehuss commented Jan 16, 2022

This is a regression in pulldown-cmark, I have opened pulldown-cmark/pulldown-cmark#567

@Nemo157
Copy link
Member

Nemo157 commented Jan 16, 2022

This also affects rustdoc 1.59.0-beta.1 (7c0b25092 2022-01-13)

@Nemo157 Nemo157 added the regression-from-stable-to-beta Performance or correctness regression from stable to beta. label Jan 16, 2022
@rustbot rustbot added the I-prioritize Issue: Indicates that prioritization has been requested for this issue. label Jan 16, 2022
@GuillaumeGomez
Copy link
Member

Thanks @ehuss !

@camelid
Copy link
Member

camelid commented Jan 17, 2022

A patch release of pulldown-cmark is about to be released. Could someone open a PR to update to it?

@camelid
Copy link
Member

camelid commented Jan 17, 2022

Ok, release is out.

@camelid camelid added this to the 1.59.0 milestone Jan 17, 2022
@GuillaumeGomez GuillaumeGomez mentioned this issue Jan 17, 2022
Merged
@GuillaumeGomez
Copy link
Member

Just opened #93012 for it.

@camelid camelid changed the title rustdoc: nested lists are not rendered as nested lists in nightly rustdoc: some nested lists are rendered incorrectly Jan 17, 2022
@camelid camelid added P-high High priority and removed I-prioritize Issue: Indicates that prioritization has been requested for this issue. labels Jan 22, 2022
@camelid
Copy link
Member

camelid commented Jan 22, 2022

Marking as P-high: regression that breaks relatively simple Markdown syntax

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 22, 2022
@matthiaskrgr
Rollup merge of rust-lang#93012 - GuillaumeGomez:pulldown-list, r=cam…
d607f89 
…elid

Update pulldown-cmark version to fix markdown list issue

Fixes rust-lang#92971.

r? `@camelid`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 22, 2022
@matthiaskrgr
Rollup merge of rust-lang#93012 - GuillaumeGomez:pulldown-list, r=cam…
3c37d63 
…elid

Update pulldown-cmark version to fix markdown list issue

Fixes rust-lang#92971.

r? ``@camelid``
@bors bors closed this as completed in f8335d9 Jan 22, 2022
ehuss pushed a commit to ehuss/rust that referenced this issue Jan 25, 2022
@matthiaskrgr @ehuss
Rollup merge of rust-lang#93012 - GuillaumeGomez:pulldown-list, r=cam…
c678458 
…elid

Update pulldown-cmark version to fix markdown list issue

Fixes rust-lang#92971.

r? ```@camelid```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
C-bug Category: This is a bug. P-high High priority regression-from-stable-to-beta Performance or correctness regression from stable to beta. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.59.0
Development

Successfully merging a pull request may close this issue.

Update pulldown-cmark version to fix markdown list issue GuillaumeGomez/rust
6 participants
@ehuss @Nemo157 @lo48576 @GuillaumeGomez @camelid @rustbot