JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Open

#2,207 opened on 2023年8月14日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.