JuliaDocs/Documenter.jl

Document how to modify IOContext parameters in outputs

Aberta

#2.207 aberto em 14 de ago. de 2023

Ver no GitHub
 (3 comentários) (0 reação) (0 responsável)Julia (513 forks)batch import
Type: Documentationgood first issue

Métricas do repositório

Stars
 (910 estrelas)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
A issue solicita um guia de instruções sobre como modificar parâmetros IOContext (por exemplo, número de colunas na saída REPL) nas saídas do Documenter.jl. Ela referencia as issues relacionadas #1450 e #942. O corpo pergunta explicitamente ao mantenedor @fredrikekre como os usuários devem usar `DisplayAs.withcontext` no Documenter. Escreva um guia curto documentando o processo, idealmente após obter esclarecimentos do mantenedor. Procure por qualquer discussão ou exemplos existentes nessas issues vinculadas.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Julia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80