Update index_en.rst #9321
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,27 @@ | ||
| Development | ||
| ------------ | ||
|
|
||
|
|
||
| PaddlePaddle adheres to the following three sections of code and document specifications. | ||
|
|
||
|
|
||
| PaddlePaddle uses git for version management and docker is used for building and testing environment. The code includes Cuda, C++, Python, Shell and other programming languages，which comply with Google C++ Style, Pep-8, and the code base includes style checking by an automatic inspection tool. Code comments need to follow the Doxygen specification, and if code that does not meet the style requirements will fail to compile with. we provide the following guidelines for the use of git, build tests and code development. | ||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| contribute_to_paddle_cn.md | ||
|
There was a problem hiding this comment. This should be contribute_to_paddle_en.md |
||
|
|
||
|
|
||
| PaddlePaddle is suitable for domestic and foreign users, including Chinese and English documents. We recommend the English version of design documents and problem descriptions. The design documents focus on problem descriptions, backgrounds, and followed by solutions. As documents are generated by Sphinx, code comments should comply with the Sphinx document standard. We recommend to use the paddlepaddle.org tool to compile and generate and preview documents locally. Please refer to: | ||
|
There was a problem hiding this comment. I do not suggest to write the first sentence. The sentence makes PaddlePaddle sound like a localized project. We should instead write something like this: PaddlePaddle is well documented in English and Chinese. We recommend using the English version of the documents and problem description. There was a problem hiding this comment. The design documents focus on problem descriptions, backgrounds, and followed by solutions. -> The design documents focus on problem descriptions, backgrounds and are followed by solutions. There was a problem hiding this comment. Sphinx document standard -> Sphinx documentation standard |
||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| write_docs_cn.rst | ||
|
There was a problem hiding this comment. I think this should be write_docs_en.rst |
||
|
|
||
| PaddlePaddle V2 defines new operations by adding new Layer. You can implement various complex layers by combining basic APIs to satisfy most applications. If you want to customize layer, please refer to the following, and welcome to propose patch. | ||
|
There was a problem hiding this comment. new Layer -> new layers. |
||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| new_layer_cn.rst | ||
|
There was a problem hiding this comment. I think this should be new_layer_en.rst |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
version management -> version control
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docker -> Docker
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doxygen specification, and if code that does not meet the style requirements will fail to compile with. -> Doxygen specification. The code that does not meet the style requirements will fail to compile.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we provide the -> We provide the
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
git -> Git