PaddlePaddle / docs

Documentations for PaddlePaddle
https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
Apache License 2.0
237 stars 707 forks source link

[Typing] Rewrite type annotations specification #6836

Closed SigureMo closed 3 weeks ago

SigureMo commented 3 weeks ago

明确类型提示标注规范内容,为其他开发者提供参考

最佳实践大多数内容是通用的,并不仅限于 Paddle,对于非 Paddle 框架开发也有参考价值

preview link: http://preview-pr-6836.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/dev_guides/style_guide_and_references/type_annotations_specification_cn.html

@megemini @zrr1999 @gouzil @sunzhongkai588

paddle-bot[bot] commented 3 weeks ago

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-6836.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html 预览工具的更多说明,请参考:飞桨文档预览工具

SigureMo commented 3 weeks ago

另外,CI 那边是不是可以加个引导了?

对,这个和代码风格指南是同等地位的,在检查失败时应该引导参考本指南