Generate manpage from configuration options
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
Rechercherichtung
Beginne damit nachzuverfolgen, wie konfigurierbare Traits die vorhandene -h-Ausgabe erzeugen und wie eine Befehlszeilenoption oder ein separater Befehl auf Traitlet-Ebene eingebunden würde. Lege fest, ob --generate-manpage oder ein separater Befehl die vorgesehene Schnittstelle ist, und überprüfe anschließend, dass die generierte Ausgabe die konfigurierbaren Optionen im Manpage-Format erfasst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
In https://github.com/jupyter/jupyter_server/issues/320, @SnarkBoojum submitted a manpage for Jupyter Server that largely encoded the results from --help. We realized that it would make more sense to have an automatically generated manpage at the traitlet level from the configurable traits. This issue is about adding a --generate-manpage option, or perhaps a separate manpage generation command, that does something similar to -h, but generates the output as a manpage.
- Vorherrschende Sprache
- Python
- Sterne
- 654
- Forks
- 222
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ipython/traitlets
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 65/100
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Add Deprecation of Trait Declarations via Classes to Migration NotesEvtl. wieder frei Ein Pull Request dazu wurde ohne Merge geschlossen. Offengood first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
-
documentation
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 65/100
-
traitlets.Set should support generic type annotations for type safetyEvtl. vergeben @GruffElixir hat das vor 38 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
Alle Issues in ipython/traitlets
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
UKGovernmentBEIS/control-arena#917 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
debpalash/VoiceStudio#2937 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
aws-samples/sample-per-model-bedrock#261 ·
Maintainer antworten meist innerhalb von 1 Tag