kubernetes-client/python

Some suggestions for improvements to auto-generated docs

Open

#2 337 ouverte le 27 janv. 2025

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (3 323 forks)batch import
help wantedkind/documentation

Métriques du dépôt

Stars
 (6 225 stars)
Métriques de merge PR
 (Merge moyen 10j 3h) (2 PRs mergées en 30 j)

Description

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 _

Guide contributeur

Direction de recherche
Enquetez sur la facon dont le code de generation de documentation produit des exemples de code et mettez le a jour pour inclure des valeurs par defaut raisonnables ou des messages d'erreur pour les classes vides, corrigez les conventions de nommage dans les exemples et ajoutez des instructions pour les arguments obligatoires.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90