JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Aperta

#2207 aperta il 14 ago 2023

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Type: Documentationgood first issue

Metriche repository

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

Descrizione

I.e. number of columns of the REPL output etc. -- would be good to have a short how-to guide for this in the docs. Related issues:

@fredrikekre: in reference to https://github.com/JuliaDocs/Documenter.jl/issues/1450, how do you imagine the user using DisplayAs.(set|with)context in Documenter? Explicitly call it in the at-example/repl block? I.e. something like this?

```@example
f() = collect('a':'z') # hide
f() |> DisplayAs.withcontext(...)
```

Guida contributor

Direzione di ricerca
La richiesta riguarda una guida pratica su come modificare i parametri IOContext (ad esempio, il numero di colonne nell'output REPL) negli output di Documenter.jl. Fa riferimento alle issue correlate #1450 e #942. Il testo chiede esplicitamente al maintainer @fredrikekre come gli utenti dovrebbero usare `DisplayAs.withcontext` in Documenter. Scrivi una breve guida che documenti il processo, idealmente dopo aver ottenuto chiarimenti dal maintainer. Cerca eventuali discussioni o esempi esistenti in quelle issue collegate.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80