markdownlint update resulting in errors listed for Command Line Cheat Sheet page

Offen Anfängerfreundlich
#67 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
68/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
markdown
Bereich
documentation

Rechercherichtung

Beginne mit docs/wiki-guide/Command-Line-Cheat-Sheet.md und .markdownlint.json und führe dann markdownlint -c .markdownlint.json -f docs/wiki-guide aus, um die MD060-Fehler zu reproduzieren. Vergleiche die betroffenen Tabellen mit dem aktualisierten Regelverhalten und bestimme, ob die Seite oder die Lint-Konfiguration geändert werden sollte; abgeschlossen bedeutet, dass die beabsichtigte Lösung dokumentiert ist und der Befehl diese Fehler nicht mehr meldet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

bug

The markdownlint behavior for MD060 was updated. Looks like it's changes from two commits:

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.

Vorherrschende Sprache
Python
Sterne
1
Forks
1
Ø Merge
6 T. 1 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Imageomics/Collaborative-distributed-science-guide

Alle Issues in Imageomics/Collaborative-distributed-science-guide

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.