JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Open

#2 207 ouverte le 14 août 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Julia (910 stars) (513 forks)batch import
Type: Documentationgood first issue

Description

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

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
needs maintainer response
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Julia basicsDocumenter.jl tutorialIOContext concept
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.