JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2.528 aberto em 14 de jun. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Type: Documentationgood first issue

Description

https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment-2165219642

We use prettier for js, and also JuliaFormatter as some point hopefully (#2404).

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
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.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Markdowncontributor guide
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85
Direção de pesquisa
Check the existing contributor documentation in the repository, likely in a CONTRIBUTING.md or docs folder. Look at the linked PR comment (https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment 2165219642) for context on the formatting tools mentioned. Add a note referencing the use of Prettier for JavaScript files and the future plan to use JuliaFormatter for Julia code (issue #2404). The note should be concise and placed in the relevant section of the contributor docs.