wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

Offen

#2.293 geöffnet am 17.07.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (297 Forks)auto 404
Good First Issue

Repository-Metriken

Stars
 (187 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die verlinkte Dokumentationsseite, identifizieren Sie Codeblöcke, die inkonsistent den Konstruktor versus Factory Methoden verwenden, und vergleichen Sie sie mit dem umgebenden Text, der auf Factory Methoden verweist. Aktualisieren Sie die Codeblöcke, um der in der Dokumentation beschriebenen Verwendung von Factory Methoden zu entsprechen. Überprüfen Sie außerdem die Verwendung von `this.runOnce` im Subsystem Kontext und stellen Sie Klarheit sicher.
Tech Stack
javacpp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70