JuliaDocs/Documenter.jl

Generalize the at-example line hiding

Open

#2025 aperta il 25 gen 2023

Vedi su GitHub
 (0 commenti) (2 reazioni) (0 assegnatari)Julia (513 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Cerca l'implementazione corrente dell'occultamento delle righe nel codice sorgente di Documenter.jl, probabilmente nei file che gestiscono i blocchi @example. Comprendi come le righe che terminano con '# hide' vengono escluse. Quindi, modifica il parsing dei blocchi per accettare un parametro opzionale 'hide' che può essere un'espressione regolare o un array di espressioni regolari. Usa occursin per confrontare ogni riga. Assicurati che la modifica sia retrocompatibile e aggiorna la documentazione di conseguenza.
Tech stack
Nessuno
Dominio
documentationbackend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaRegex
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65