Skip to content
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.

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

[Docs][en] adjust code example format #44679

Merged
merged 8 commits into from
Aug 4, 2022

Conversation

SigureMo
Copy link
Member

@SigureMo SigureMo commented Jul 27, 2022

PR types

Others

PR changes

Docs

Describe

对部分示例代码格式上进行了调整

  • 为需要用 :name: 属性来区分多个 code-block 添加 :name: 属性
  • 删除不需要用 :name: 属性来区分多个 code-block 的情况中的 :name: 属性
  • 由于很多示例代码缩进没有对齐(.. code-block 下 4 缩进),因此有些缩进的修改
  • 有些英文文档没示例代码,结果无法利用 COPY-FROM 到中文文档,因此从历史里找到中文文档示例代码 copy 过来
  • 还有些 Examples: 格式不标准导致无法 copy 过去

整体上没有对示例代码内容上进行任何修改

中文文档同步修改: PaddlePaddle/docs#4973

@paddle-bot
Copy link

paddle-bot bot commented Jul 27, 2022

你的PR提交成功,感谢你对开源项目的贡献!
请关注后续CI自动化测试结果,详情请参考Paddle-CI手册
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

@SigureMo SigureMo changed the title [Docs][en] add name attribute to code-block [Docs][en] fix code example issues Aug 3, 2022
@SigureMo SigureMo changed the title [Docs][en] fix code example issues [Docs][en] adjust code example format Aug 3, 2022
@SigureMo
Copy link
Member Author

SigureMo commented Aug 3, 2022

image

@XiaoguangHu01

是一个修改文档示例代码格式的 PR,没有修改示例代码内容

修改超过 20 个文件了,可以麻烦有时间 review 下嘛?

Copy link
Contributor

@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

Copy link
Contributor

@XiaoguangHu01 XiaoguangHu01 left a comment

Choose a reason for hiding this comment

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

LGTM

@Ligoml Ligoml merged commit d5de788 into PaddlePaddle:develop Aug 4, 2022
@SigureMo SigureMo deleted the add-sample-code-label branch August 26, 2022 13:00
@SigureMo SigureMo mentioned this pull request Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor External developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants