JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Offen

#2.207 geöffnet am 14.08.2023

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

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

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

Research-Richtung
Das Issue fordert eine Anleitung, wie IOContext Parameter (z. B. die Anzahl der Spalten in der REPL Ausgabe) in Documenter.jl Ausgaben geändert werden können. Es verweist auf die verwandten Issues #1450 und #942. Der Text fragt den Maintainer @fredrikekre ausdrücklich, wie Benutzer `DisplayAs.withcontext` in Documenter verwenden sollen. Verfassen Sie eine kurze Anleitung, die den Prozess dokumentiert, idealerweise nachdem Sie eine Klärung vom Maintainer erhalten haben. Suchen Sie nach vorhandenen Diskussionen oder Beispielen in diesen verlinkten Issues.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80