Fix/markdownlint #15205
Fix/markdownlint #15205
Conversation
|
aa |
There was a problem hiding this comment.
Pull request overview
This PR fixes markdown linting issues across multiple documentation files in the typeshed repository. The changes primarily address formatting inconsistencies to comply with markdownlint rules.
Key changes:
- Standardized heading levels (top-level documents now use
#for main headers instead of missing headers or##) - Added blank lines before code blocks for proper markdown formatting
- Converted list markers from
-to*for consistency - Replaced HTML table with standard markdown subsections in CONTRIBUTING.md
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/REGRESSION.md | Changed main header from ## to #, subsection from ### to ##, and updated emphasis from _won't_ to *won't* |
| tests/README.md | Added # header to first line, added blank lines before code blocks throughout the document |
| README.md | Wrapped URL in angle brackets and removed $ prompt from bash command |
| MAINTAINERS.md | Converted first line to proper header with # prefix |
| CONTRIBUTING.md | Removed exclamation mark from header, added "Code formatting" section, converted HTML table to markdown subsections, standardized list markers to *, removed extra blank line, added blank lines before code blocks |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```bash | ||
| $ python3 tests/check_typeshed_structure.py | ||
| python3 tests/check_typeshed_structure.py |
There was a problem hiding this comment.
The command prompt was removed from this code block, making it inconsistent with all other bash code blocks in this file which use the (.venv3)$ prefix (e.g., lines 27-30, 38, 58, 113, 149, 157, 164, 216). For consistency, this should either include the prompt like the others, or all prompts should be removed throughout the file.
| python3 tests/check_typeshed_structure.py | |
| (.venv3)$ python3 tests/check_typeshed_structure.py |
|
I don't think this is helpful. I'm general, we need a clear motivation for changing our documentation, which AI generated descriptions can't provide. |
1 similar comment
|
I don't think this is helpful. I'm general, we need a clear motivation for changing our documentation, which AI generated descriptions can't provide. |
2 participants
No description provided.