wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

Aberta

#2.293 aberto em 17 de jul. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)JavaScript (297 forks)auto 404
Good First Issue

Métricas do repositório

Stars
 (187 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

https://docs.wpilib.org/en/2023_a/docs/software/commandbased/commands.html

Currently there is an inconsistent/incomplete mix of using the constructor and using the factory method inside the code blocks, while the documentation refers to the factory methods.

The code blocks/RLIs also use the factory methods of Subsystem in the context of a subsystem (eg using this.runOnce) which can be confusing without the surrounding context.

Guia do colaborador

Direção de pesquisa
Revise a página de documentação vinculada, identifique blocos de código que usam de forma inconsistente o construtor versus métodos de fábrica e compare com o texto ao redor que se refere aos métodos de fábrica. Atualize os blocos de código para corresponder ao uso do método de fábrica descrito na documentação. Além disso, verifique o uso de `this.runOnce` no contexto do subsistema e garanta clareza.
Pilha de tecnologia
javacpp
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.
2
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.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70