kubernetes-client/python

Some suggestions for improvements to auto-generated docs

Open

#2337 aperta il 27 gen 2025

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Python (3323 fork)batch import
help wantedkind/documentation

Metriche repository

Star
 (6225 star)
Metriche merge PR
 (Merge medio 10g 3h) (2 PR mergiate in 30 g)

Descrizione

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 _

Guida contributor

Direzione di ricerca
Indaga come il codice di generazione della documentazione produce esempi di codice e aggiornalo per includere valori predefiniti sensati o messaggi di errore per classi vuote, correggi le convenzioni di denominazione negli esempi e aggiungi indicazioni per gli argomenti obbligatori.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90