JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Ouverte

#2 207 ouverte le 14 août 2023

Voir sur GitHub
 (3 commentaires) (0 réaction) (0 personne assignée)Julia (513 forks)batch import
Type: Documentationgood first issue

Métriques du dépôt

Stars
 (910 étoiles)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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

Direction de recherche
Cette demande concerne un guide pratique sur la façon de modifier les paramètres IOContext (par exemple, le nombre de colonnes dans la sortie REPL) dans les sorties de Documenter.jl. Elle fait référence aux issues connexes #1450 et #942. Le corps demande explicitement au mainteneur @fredrikekre comment les utilisateurs doivent utiliser `DisplayAs.withcontext` dans Documenter. Rédigez un court guide documentant le processus, idéalement après avoir obtenu des clarifications du mainteneur. Recherchez toute discussion ou exemple existant dans ces issues liées.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80