JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Open

#2,207 opened on Aug 14, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)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(...)
```

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Julia basicsDocumenter.jl tutorialIOContext concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.