kubernetes-client/python

Some suggestions for improvements to auto-generated docs

开放

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

 (3 条评论) (0 个反应) (0 位负责人)Python (3,323 个派生)batch import
help wantedkind/documentation

仓库指标

星标
 (6,225 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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 _

贡献者指南