Skip to content

chore(tooling): configure markdownlint ul indent to 4 #1460

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.

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

Merged
merged 3 commits into from
Apr 16, 2025

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Apr 16, 2025

🗒️ Description

Correctly configure markdownlint to expect an indentation of 4. An indent of 4 is required for HTML documentation to render correctly. For example, the 2 highlighted items are included incorrectly as top-level items, but should be a sub-list:
image

🔗 Related Issues

None.

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.

@danceratopz danceratopz added type:chore Type: Chore scope:tooling Scope: Python tools (uv, ruff, tox,...) labels Apr 16, 2025
Copy link
Contributor

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks :)

@danceratopz danceratopz merged commit 84d28db into main Apr 16, 2025
21 checks passed
@danceratopz danceratopz deleted the configure-markdown-indent branch April 16, 2025 09:32
pacrob pushed a commit to pacrob/execution-spec-tests that referenced this pull request May 5, 2025
felix314159 pushed a commit to felix314159/execution-spec-tests that referenced this pull request May 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:tooling Scope: Python tools (uv, ruff, tox,...) type:chore Type: Chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants