kubernetes-client/python

Some suggestions for improvements to auto-generated docs

Open

#2,337 创建于 2025年1月27日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (6,225 star) (3,323 fork)batch import
help wantedkind/documentation

描述

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 _

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonBasic understanding of Kubernetes resources
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Investigate the auto generation pipeline in the kubernetes client/python repository, specifically the templates or scripts that produce the documentation files. Identify where empty class examples are generated and modify the code to either include arguments or display a helpful error message. Additionally, adjust the naming convention for name and namespace parameters to use hyphens instead of underscores, ensuring consistency with Kubernetes naming conventions.
Some suggestions for improvements to auto-generated docs · kubernetes-client/python#2337 | Good First Issue