JuliaDocs/Documenter.jl

Markdown AST linting

Open

#2.059 aberto em 6 de mar. de 2023

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)Julia (513 forks)batch import
Type: Featurehelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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

Guia do colaborador