[文档] 自动生成所有类的"属性"部分
作者: harshil21创建于 2026年5月20日更新于 2026年6月1日
标签⚙️ documentation
目前,我们手动为每个班级写出属性部分. 几乎所有属性都只是从Args部分复制过来,只有几件事会改变,对于大多数情况:
,可选'-备选'。- 序列[.] -- -- > 二联 [.]
我提议把这项任务自动化 这将有助于删除上千行代码,使审查更快,减少包大小,还有助于消除一整类文档错误.
如何做到这一点? 我们已经做了非常相似的东西 与Bot关键字参数插入和# 5241。 这项工作将以类似方式进行:
- 检查该类是否有没有文件记载的公共属性
- 如果有,跳过,因为这是手动记录的(也许因为它是一个边缘案例)
- 如果没有,请看Args部分,看看我们是否同名,这样我们就可以复制描述
- 复制说明、警告(如版本已更改)并采用上述变换。
- 如果我们不这样做,就发出警告,告诉用户手动文档,因为无法找到合适的文件复制。
可能有几件有这种逻辑的边缘案例,这就是为什么手动记录一些属性的能力是一个很好的中间点.
内容来源: python-telegram-bot/python-telegram-bot