Skip to content

按在线文档需求 61 ~ 70 修订部分 rst 文档 #5508

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Ligoml merged 9 commits into from
Dec 14, 2022
Merged

按在线文档需求 61 ~ 70 修订部分 rst 文档 #5508

Ligoml merged 9 commits into from
Dec 14, 2022

Conversation

@LearningPawn
Copy link
Contributor

@LearningPawn LearningPawn commented Dec 12, 2022 •
edited by Ligoml
Loading

PR types

Others

PR changes

Docs

Describe

修订部分 rst 文档：

  1. 修整 docs/api/paddle/cast_cn.rst 中的多余缩进；
  2. 调整 docs/api/paddle/static/Print_cn.rst 中参数描述的位置，按自己的理解以及 API 文档书写规范修订了返回值的描述（
    参考了 print_op.cc 88 行左右的代码）；
  3. 为 docs/api/paddle/io/DataLoader_cn.rst 中函数描述里缺少 可选 描述的进行添加；
  4. 去除 docs/api/paddle/static/nn/sequence_unpad_cn.rst 中错误的内容 :api_attr：；
  5. 为 docs/api/paddle/static/nn/sequence_slice_cn.rst 改进中文格式，参考了 docs/api/paddle/static/nn/sequence_scatter_cn.rst 中的 21~43 行的描述格式；
  6. 去除 docs/api/paddle/log_cn.rst 中 “该 OP” 的表述；
  7. 修改 docs/api/paddle/static/nn/data_norm_cn.rst 中函数参数，改为与参数说明对应的 14 个，添加 可选 描述。

英文文档：PaddlePaddle/Paddle#49014

@LearningPawn
修订部分 rst 文档：
04233b7 
1. 修整 docs/api/paddle/cast_cn.rst 中的多余缩进；
2. 调整 docs/api/paddle/static/Print_cn.rst 中参数描述的位置，按自己的理解以及 API 文档书写规范修订了返回值的描述；
3. 为 docs/api/paddle/io/DataLoader_cn.rst 中函数描述里缺少 可选 描述的进行添加；
4. 去除 docs/api/paddle/static/nn/sequence_unpad_cn.rst 中错误的内容 `:api_attr：`；
5. 为 docs/api/paddle/static/nn/sequence_slice_cn.rst 改进中文格式，参照了 docs/api/paddle/static/nn/sequence_scatter_cn.rst 中的部分规范；
6. 去除 docs/api/paddle/log_cn.rst 中 “该 OP” 的表述；
7. 修改 docs/api/paddle/static/nn/data_norm_cn.rst 中函数参数，改为与参数说明对应的 14 个，添加 可选 描述。
@LearningPawn
Merge branch 'develop' of https://ghproxy.com/https://github.com/Padd…
1bc9cd6 
…lePaddle/docs into my-cool-stuff
@paddle-bot
Copy link

paddle-bot bot commented Dec 12, 2022

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

Ligoml
Ligoml reviewed Dec 13, 2022
View reviewed changes
@Ligoml
Copy link
Collaborator

Ligoml commented Dec 13, 2022

good job！有几处小细节建议修改~

@LearningPawn
Copy link
Contributor Author

LearningPawn commented Dec 14, 2022

@Ligoml 感谢您的 Review，中文文档已经根据您的意见进行了修订并 commit。再次感谢您的 Review！

@Ligoml Ligoml mentioned this pull request Dec 14, 2022
Merged
Ligoml
Ligoml approved these changes Dec 14, 2022
View reviewed changes
Copy link
Collaborator

@Ligoml Ligoml left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job！LGTM for docs

@Ligoml Ligoml merged commit 531e627 into PaddlePaddle:develop Dec 14, 2022
@LearningPawn LearningPawn deleted the my-cool-stuff branch December 14, 2022 09:25
@LearningPawn LearningPawn restored the my-cool-stuff branch December 14, 2022 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Ligoml Ligoml Ligoml approved these changes

Assignees

No one assigned

Labels

contributor status: proposed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@LearningPawn @Ligoml