Provide proper SDK Documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先，将 Python SDK 生成的字段描述与 issue 中链接的 Go SDK 示例进行比较。确定文档生成的入口点以及受影响 API 模型的范围；当 Python 用户获得有意义的属性描述，而不是重复的占位文本时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
I see that the go SDK has great API documentation (example).
The python SDK only provides rather useless text parts:
The value to assign to XXX of this YYY.
It would be great if also the python folks can benefit from good documentation.
Thanks!
- 主要语言
- Python
- 星标
- 473
- 派生
- 322
- 平均合并
- 13 分钟
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
oracle/oci-python-sdk 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 48/100
oracle/oci-python-sdk#890 · 3 条评论 ·
-
难度 4/5 3-5 天 新手友好度 45/100
oracle/oci-python-sdk#879 · 3 条评论 ·
-
Example uses non-existent API可能已有人在做 @reginaldalfret 于 7 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 66/100
oracle/oci-python-sdk#878 ·
-
SDK
难度 3/5 1-2 天 新手友好度 55/100
oracle/oci-python-sdk#861 · 5 条评论 ·
-
SDK
难度 2/5 1-3 小时 新手友好度 48/100
oracle/oci-python-sdk#852 ·
查看 oracle/oci-python-sdk 的全部 Issue
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 85/100
tharje/spooler-v2#20 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
Bump version of azure-servicebus可能已有人在做 @joostlek 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
home-assistant/core#186275 ·
维护者通常 1 天内回复
-
documentation
难度 1/5 1 小时以内 新手友好度 72/100