Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update instalL_NGC_PaddlePaddle_ch.rst #5338

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

onecatcn
Copy link
Collaborator

@onecatcn onecatcn commented Oct 9, 2022

update the description for container verison

@paddle-bot
Copy link

paddle-bot bot commented Oct 9, 2022

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

update the description for container version number
@onecatcn
Copy link
Collaborator Author

onecatcn commented Oct 16, 2022

@SigureMo 首先pre-commit是个好东西,感谢!我感觉是不是规则还可以完善一下?字面上说的是要求中英文之间有空格,但是这个PR被block是因为阿拉伯数字与中文之间没空格。这其实不符合我们日常的书写习惯。
最近又一些PR被block了,我估计是这个原因(例如XPU的PR #5361 ,当然主要原因还是提交者没有用pre-commit)。
NOTE-这个关于NGC的PR已经重新提交(#5366 ),通过pre-commit修改后通过了,这样我才发现被block的原因
4e8fc5d9bfe907f65175dea1f9d85df6

@SigureMo
Copy link
Member

SigureMo commented Oct 16, 2022

感谢反馈这一问题,关于规则的话,由于当时只是仓促提交的初版,确实提示信息并不完全。

这个PR被block是因为阿拉伯数字与中文之间没空格。这其实不符合我们日常的书写习惯。

关于添加空格的问题,首先这里是遵守基本格式规范 - 文本规范内容,在中英文之间一定要加空格的,而中文和数字之间是否加空格当时是有一个简单的讨论的,当时的结论是中文和数字之间也要加空格,因此现有文档中都加了空格,而为了保持一致,我认为所有新的文档也都应该加上空格。

最近又一些PR被block了,我估计是这个原因(例如XPU的PR #5361 ,当然主要原因还是提交者没有用pre-commit)。

这里或许主要是因为之前的 docs 下的规则较为宽松,不使用 pre-commit 也能通过 PR,因此 docs 的贡献者并没有安装 pre-commit 的习惯,导致问题频繁发生,因此也许在 CI 中做一些引导是比较好的解决方式,并且我也会修改下添加空格 hook 的提示信息,以使得报错信息更加清晰~

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants