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

update split_lod_tensor, create_array and array_length doc #11383

Merged
merged 28 commits into from
Jun 17, 2018

Conversation

jacquesqiao
Copy link
Member

No description provided.

@jacquesqiao
Copy link
Member Author

@skylarch 求检查一下格式是否符合要求

@skylarch
Copy link
Collaborator

需要添加function description、formula、和formula中符号的解释。示例可见:http://www.paddlepaddle.org/docs/develop/documentation/fluid/zh/dev/api_doc_std_cn.html

@jacquesqiao
Copy link
Member Author

@skylarch 这几个api没有公式呢

@skylarch
Copy link
Collaborator

skylarch commented Jun 12, 2018

@jacquesqiao
create_tensor:
标题格式除介词外首字母大写,无句号;
[(Data Type, Default Value)]:缺default
缺Formula(如果现在还没有就不用改)

split_lod_tensor:
标题格式除介词外首字母大写,无句号;
[(Data Type, Default Value)]:缺default

array_length:
标题格式除介词外首字母大写,无句号;

你还在添加不包括在pr标题中的API的commit,所以如果之后还会添加新的commit,我就先不approve;如果之后的commit会新开pr,我就把这个pr approve。

Copy link
Collaborator

@skylarch skylarch left a comment

Choose a reason for hiding this comment

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

request changes as commented

@skylarch skylarch requested a review from reyoung June 13, 2018 04:51
@skylarch
Copy link
Collaborator

@jacquesqiao
现在@reyoung 老师可能对注释内容有新的建议,API注释标准暂时待定,之前的comment可以先不做修改。

@skylarch skylarch removed the request for review from reyoung June 13, 2018 07:39
@jacquesqiao
Copy link
Member Author

image

image

image

image

image

@skylarch
Copy link
Collaborator

@jacquesqiao

split_lod_tensor
删除function description的标题(更多标准见http://agroup.baidu.com/paddlepaddle/md/article/976426)

screen shot 2018-06-14 at 1 29 57 pm

batch_norm
参数介绍不全
缺return,example

switch
缺参数介绍,return

如果API没有return,需在return项标出。

@jacquesqiao
Copy link
Member Author

  1. split_lod_tensor已删除
  2. batch_norm 的后半部分。
    image

skylarch
skylarch previously approved these changes Jun 14, 2018
@reyoung
Copy link
Collaborator

reyoung commented Jun 14, 2018

default

default

default

default

default

default

default

default

default

@reyoung
Copy link
Collaborator

reyoung commented Jun 14, 2018

另外,似乎reverse 的文档找不到。

@reyoung
Copy link
Collaborator

reyoung commented Jun 15, 2018

default

default

default

default

default

default

default

default

@reyoung
Copy link
Collaborator

reyoung commented Jun 17, 2018

default
default
default

Copy link
Collaborator

@reyoung reyoung left a comment

Choose a reason for hiding this comment

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

Finally done. Thanks.

@reyoung reyoung merged commit 16a0f74 into PaddlePaddle:develop Jun 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants