Imageomics / Imageomics/Collaborative-distributed-science-guide
markdownlint update resulting in errors listed for Command Line Cheat Sheet page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
The markdownlint behavior for MD060 was updated. Looks like it's changes from two commits:
- https://github.com/DavidAnson/markdownlint/commit/9b116ae889d475cafe1d57a98d43637ace8ba778
- https://github.com/DavidAnson/markdownlint/commit/f6c5369ef404308d3b6060d216ccc4f6c204b55c
When I run
markdownlint -c .markdownlint.json -f docs/wiki-guide
I get repeated warnings (multiple lines) for the Command Line Cheat Sheet:
docs/wiki-guide/Command-Line-Cheat-Sheet.md:13:14 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:14:8 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:15:10 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:15:1 error MD060/table-column-style Table column style [Table pipe is missing space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:16:9 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
...
docs/wiki-guide/Command-Line-Cheat-Sheet.md:35:32 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:35:32 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:36:29 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:36:29 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:37:30 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:37:30 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
We should investigate the change and update as needed (the page, the markdownlintignore, etc.). The tables in the page are certainly not cleanly aligned. Autofix is an open issue.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/wiki-guide/Command-Line-Cheat-Sheet.md and .markdownlint.json, then run markdownlint -c .markdownlint.json -f docs/wiki-guide to reproduce the MD060 errors. Compare the affected tables with the updated rule behavior and determine whether the page or lint configuration should change; done means the intended resolution is documented and the command no longer reports these errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100