JuliaDocs/Documenter.jl

Markdown AST linting

Open

#2 059 ouverte le 6 mars 2023

Voir sur GitHub
 (0 commentaires) (1 réaction) (0 assignés)Julia (513 forks)batch import
Type: Featurehelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

There are some common errors people make with Markdown that are pretty clearly errors, but parse into valid AST (everything does), and so go unnoticed (e.g. forgetting to have closing fences for code blocks). We could implement a linting mode for Documenter, as part of docchecks, that tries to catch these.

Two steps for a useful feature:

  • A new linting step as part of docchecking. Key here is that it should be possible to disable this on its own (e.g. if you get false positives).
  • The code fence closing linter should be relatively straightforward to implement.

Suggested by @giordano: https://github.com/JuliaLang/julia/pull/48893#issuecomment-1455197197

Guide contributeur