/community/documentation.md #77
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
编写 TensorFlow 文档
|
校对认领 |
|
@daa233 原文和译文的行没有对应，能否调整一下。 |
|
@luochen1992 我刚刚看了，其实行号是对应的，但左右的内容却没有对齐。因为这个原文的 md 文件没有按段落断行，所以翻译的时候很难完整地对应起来。我之前跟 @leviding 说了这个情况，决定先尽可能地将行号对应起来，merge 前再对两个 md 文件统一修改。 现在的左右内容不对齐，是不是因为空行不一致导致的？行号大致都是对应起来的。 |
|
这个 TensorFlow 比较特殊，原文是有很多断行的，只能说尽量对应，无法完全对应也是正常的。 |
luochen1992
reviewed
May 14, 2018
community/documentation.md
Outdated
| but we are unlikely to accept other documentation formats (or the tooling to | ||
| generate them) into our repository. If you do choose to republish our | ||
| documentation in another form, please be sure to include: | ||
| 我们绝对允许通过不同的形式的重新发布 TensorFlow 文档， |
There was a problem hiding this comment.
『我们绝对允许通过不同的形式的重新发布 TensorFlow 文档』=>『我们非常欢迎通过不同的形式重新发布 TensorFlow 文档』
“绝对允许”听起来很奇怪。
community/documentation.md
Outdated
| * The commit or version from which the documentation was generated | ||
| * Where to get the latest documentation (that is, https://www.tensorflow.org) | ||
| * The Apache 2.0 license. | ||
| * 这种格式的文档对应的 API 版本 (例如 r1.0、master 等等) |
community/documentation.md
Outdated
| * The Apache 2.0 license. | ||
| * 这种格式的文档对应的 API 版本 (例如 r1.0、master 等等) | ||
| * 这份文档是从哪次提交或者哪个版本产生的 | ||
| * 从哪里 (即 https://www.tensorflow.org) 可以找到最新版本的文档 |
community/documentation.md
Outdated
| [cherrypick](https://stackoverflow.com/questions/9339429/what-does-cherry-picking-a-commit-with-git-mean)). | ||
| 但是，大多数的开发者都是向 GitHub 的 master 分支里的文档做贡献， | ||
| 这份文档 | ||
| 会在[tensorflow.org/versions/master](https://www.tensorflow.org/versions/master) 不定时地发布。 |
community/documentation.md
Outdated
|
|
||
| - <code>@{tensorflow::symbol}</code> to make a link to the reference page | ||
| for a C++ symbol. | ||
| - <code>@{$doc_page}</code> 链接到另一个文档页面 (非 API 参考)。 |
community/documentation.md
Outdated
| [API guides](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/docs_src/api_guides). | ||
| Otherwise, add them to the module or class docstring where the Ops constructors | ||
| are called out. | ||
| 用 Python 来展示示例代码经常是有帮助的。永远不要将它们放到 C++ 的 |
There was a problem hiding this comment.
『用 Python 来展示示例代码经常是有帮助的』=>『最好使用 Python 来展示示例代码』
community/documentation.md
Outdated
|
|
||
| Before building the documentation, you must first set up your environment by | ||
| doing the following: | ||
| 在构建文档之前，你必须先完成以下步骤来安装环境: |
community/documentation.md
Outdated
| 文档中显示少量导入的模块（或打破了 | ||
| 生成器），你可以简单地在导入时重命名它们，例如：`import sys as _sys`。 | ||
|
|
||
| 因为 Python 会将所有的文件视为模块，所以这也适用与文件。 |
community/documentation.md
Outdated
| be fed using the `feed_dict` optional argument to `Session.run()`, | ||
| `Tensor.eval()`, or `Operation.run()`. | ||
| 说明：如果对这个张量求值会产生错误。它的值必须 | ||
| 使用可选参数 `feed_dict` 导入 `Session.run()`、 |
There was a problem hiding this comment.
『它的值必须使用可选参数 feed_dict 导入 Session.run()、Tensor.eval() 或 Operation.run()。』=>『它的值必须使用 Session.run()、Tensor.eval() 或 Operation.run() 的可选参数 feed_dict 导入 。』
community/documentation.md
Outdated
| 请记住，对于 C++ 操作，张量的类型是自动添加的， | ||
| 为“A ..type .. Tensor”或“A类型在{...list of types...}”。 | ||
| 在这种情况下，如果操作对 | ||
| 张量的维度有约束，则可以添加诸如“必须为4维”的文本，或者用 |
|
@luochen1992 谢谢你的校对，感谢指正错误。我会尽快抽时间根据校对意见修改。 |
根据 @luochen1992 意见校对完成
|
已根据 @luochen1992 意见修改完成。@leviding |
|
@daa233 现在把不应该断行的地方调整回来吧，我帮忙调整了一点，你把剩下的调整完吧 |
|
@leviding 好的 |
修复段间换行
|
@leviding 断行调整完成 |
leviding
approved these changes
May 20, 2018
|
@daa233 看下 commit 记录，我对问题进行了调整哈。之后翻译校对的时候注意下。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/community/documentation.md 翻译完成，@leviding
resolve #69