JuliaDocs/Documenter.jl

Generalize the at-example line hiding

Open

#2 025 ouverte le 25 janv. 2023

Voir sur GitHub
 (0 commentaires) (2 réactions) (0 assignés)Julia (513 forks)batch import
Type: Enhancementhelp 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

Currently, you can only hide lines that end with # hide. We could generalize it by allowing the user to pass a hide option to the block which should be a regex (or an array of regexes) that we then occursin against the lines.Potential use cases:

  • Hiding JuliaFormatter #! format: off with e.g. a r"^#! format:" regex.
  • Filtering out comments with r"^#
```@example my-block; hide = r"^#! format:"
#! format: off
weirdly_formatted_code_that_I_want_to_keep_that_way(...)
#! format: on
```

X-ref: https://discourse.julialang.org/t/interaction-between-logging-jl-juliaformatter-jl-and-documenter-jl/93504

Guide contributeur