kubernetes-client/python

Some suggestions for improvements to auto-generated docs

オープン

#2,337 opened on 2025/01/27

 (3 件のコメント) (0 件のリアクション) (0 人の担当者)Python (3,323 件のフォーク)batch import
help wantedkind/documentation

Repository metrics

Stars
 (6,225 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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 _

コントリビューターガイド