JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Open

#2.207 geöffnet am 14. Aug. 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (910 Stars) (513 Forks)batch import
Type: Documentationgood first issue

Beschreibung

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(...)
```

Contributor Guide

Tech Stack
Keine
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
needs maintainer response
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Julia basicsDocumenter.jl tutorialIOContext concept
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
The issue requests a how to guide for modifying IOContext parameters (e.g., number of columns in REPL output) in Documenter.jl outputs. It references related issues #1450 and #942. The body explicitly asks maintainer @fredrikekre how users should use `DisplayAs.withcontext` in Documenter. Write a short guide documenting the process, ideally after getting clarification from the maintainer. Look for any existing discussion or examples in those linked issues.