Some suggestions for improvements to auto-generated docs
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 52/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza con la documentación autogenerada enlazada en kubernetes/docs/CoreV1Api.md, especialmente replace_namespaced_secret y replace_namespaced_service_account, y reproduce el error de V1ServiceAccount(). Comprueba cómo se generan los ejemplos; se considera terminado cuando la orientación o los argumentos para la clase vacía sean utilizables y los ejemplos de nombre y namespace sigan el formato de nombres de Kubernetes.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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()toreplace_namespaced_service_accountand you'll get an errorthe 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 _
- Lenguaje dominante
- Python
- Estrellas
- 7.7k
- Forks
- 3.5k
- Merge medio
- 2 d 5 h
- PR fusionados (30 d)
- 24
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de kubernetes-client/python
-
kind/bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
kubernetes-client/python#2280 · 16 comentarios · 9 reacciones ·
Los mantenedores suelen responder en 1 día
-
Release 1.37Quizá libre de nuevo @yliaog la tomó hace 30 días y no hay ningún pull request abierto. Abierto
kubernetes-client/python#2691 · 1 comentario · 1 reacción · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Growing library sizeAbiertohelp wanted
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
kubernetes-client/python#2677 · 13 comentarios · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Add option to disable strict x509 verifcation in sync clientQuizá libre de nuevo @Vishwa0223 la tomó hace 34 días y no hay ningún pull request abierto. Abiertohelp wanted kind/feature
kubernetes-client/python#2602 · 6 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
v36.0.0 regression fetching container logsQuizá libre de nuevo @yliaog la tomó hace 73 días y no hay ningún pull request abierto. Abiertokind/bug
kubernetes-client/python#2596 · 13 comentarios · 2 reacciones · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de kubernetes-client/python
Issues similares
-
Broken links found in docsAbiertodocs pydanty:is-working
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
pydantic/pydantic-ai#8863 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
run-llama/llama_index#23278 ·
Los mantenedores suelen responder en 2 días
-
documentation from-review-extraction github-actions priority: low severity:nit
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
LearningCircuit/local-deep-research#6946 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
oracle/langchain-oracle#323 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
tenstorrent/tt-metal#58057 · 1 comentario ·
Los mantenedores suelen responder en 1 día