Skip to content

Conversation

@joshrotenberg
Copy link
Contributor

The markdown list markers in a list in the SUMMARY.md must be of the same type to avoid creating a new list, which results in the remaining list items not being rendered. This should arguably produce an error or be handled in some other way, but in lieu of that, here is some documentation.

This clarifies the issue seen in #1517.

@ehuss
Copy link
Contributor

ehuss commented Jun 6, 2021

Thanks for the PR! I'm wondering, since this is an issue that should be extremely rare, could the clarification perhaps be a little shorter? It takes up a significant amount of space, and I'd like to retain as much clarity here. Perhaps something like this?

Numbered chapters can be denoted with either - or * (do not mix delimiters).

doc clarification on markdown list markers

shorten
@joshrotenberg joshrotenberg force-pushed the markdown_list_clarification branch from 0c9f610 to 515a253 Compare June 7, 2021 02:00
@joshrotenberg
Copy link
Contributor Author

You're right. I shortened it.

Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ehuss ehuss merged commit b899c48 into rust-lang:master Jun 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants