kubernetes-client/python

Some suggestions for improvements to auto-generated docs

Open

#2.337 geöffnet am 27. Jan. 2025

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (3.323 Forks)batch import
help wantedkind/documentation

Repository-Metriken

Stars
 (6.225 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 10T 3h) (2 gemergte PRs in 30 T)

Beschreibung

I noticed a few minor improvements that can be made to the auto-generated docs. Admittedly, these changes are obvious for the user to make, but typically one expects examples to work out-of-the-box as much as possible.

  • The empty classes don't always work. For example, pass in a empty kubernetes.client.V1ServiceAccount() to replace_namespaced_service_account and you'll get an error the name of the object (name-example based on URL) was undeterminable: name must be provided. The class could use arguments or a message telling the user to provide arguments.
  • name does not follow kubernetes naming format, should have - instead of _
  • namespace does not follow kubernetes naming format, should have - instead of _

Contributor Guide

Research-Richtung
Untersuchen Sie, wie der Dokumentationsgenerierungscode Beispielcode erstellt, und aktualisieren Sie ihn, um sinnvolle Standardwerte oder Fehlermeldungen für leere Klassen zu enthalten, korrigieren Sie Namenskonventionen in Beispielen und fügen Sie Anleitungen für erforderliche Argumente hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90