JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Open

#2,207 建立於 2023年8月14日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Julia (910 star) (513 fork)batch import
Type: Documentationgood first issue

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Julia basicsDocumenter.jl tutorialIOContext concept
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.