fix(docs): Correct nested bullet point format for mkdocs #12378
Merged
Conversation
This file contains 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
jerome3o
requested review from
ritchie46,
c-peters and
stinodego
as code owners
jerome3o
changed the title
jerome3o
changed the title
jerome3o
force-pushed
the
fix/installation-docs-bullet-points
branch
from
9a2f3b7 to
3daa9a2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
I been reading through the docs to get started with polars (absolutely loving it btw) and notice there are some formatting issues with bullet points. With mkdocs nested bullet points need two tabs additional to be rendered properly, I've fixed this in the installation.md and aggregation.md files
Also note that I put in some ignore flags for the dprint linter around the bullet points. I couldn't find any finer-grained configuration options.
Before:
After: