Imageomics / Imageomics/Collaborative-distributed-science-guide
markdownlint update resulting in errors listed for Command Line Cheat Sheet page
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con docs/wiki-guide/Command-Line-Cheat-Sheet.md e .markdownlint.json, quindi esegui markdownlint -c .markdownlint.json -f docs/wiki-guide per riprodurre gli errori MD060. Confronta le tabelle interessate con il comportamento aggiornato della regola e determina se debba essere modificata la pagina o la configurazione di lint; il lavoro è completato quando la risoluzione prevista è documentata e il comando non segnala più questi errori.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 68/100