docs icon indicating copy to clipboard operation
docs copied to clipboard

fix docs bugs

Open xiongjunfeng opened this issue 3 years ago • 3 comments

PR types

Bug fixes

PR changes

APIs

Describe

Issues: https://github.com/PaddlePaddle/docs/issues/5002 https://github.com/PaddlePaddle/docs/issues/5032

1.IPUPlace的源代码 https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/device/init.py#L81 显示这是一个function,而中文版API https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/device/IPUPlace_cn.html 却标注为class,认为应该以源代码为准,因此修改了 docs/api/paddle/device/IPUPlace_cn.rst

2.docs/api/paddle/fft/fft_cn.rst 中在参数部分有2处错误的换行,其中将一个句号的换行可能导致了 中文版API https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/fft/fft_cn.html#canshu 页面上参数部分,参数axis的描述被作为参数n的后续描述了。因此修改该部分错误。

现在已经可以看到预览效果,对该rst的修改解决了该问题。

xiongjunfeng avatar Jul 05 '22 07:07 xiongjunfeng

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

paddle-bot-old[bot] avatar Jul 05 '22 07:07 paddle-bot-old[bot]

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

:white_check_mark: Ligoml
:white_check_mark: xiongjunfeng
:x: xiong


xiong seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Jul 05 '22 07:07 CLAassistant

cla还没有完成签署,完成后可以合入pr @xiongjunfeng 和研发确认了一下,class是对的哈

Ligoml avatar Aug 03 '22 09:08 Ligoml