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.