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.

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

add comments for File API in proto files; 给 proto 代码添加注释 #652

Closed
seeflood opened this issue Jun 14, 2022 · 4 comments
Closed

add comments for File API in proto files; 给 proto 代码添加注释 #652

seeflood opened this issue Jun 14, 2022 · 4 comments
Assignees
@XiaoYaoheihei
Labels
good first issue Good for newcomers help wanted Extra attention is needed kind/comments kind/easy

Comments

@seeflood
Copy link
Member

seeflood commented Jun 14, 2022 •
edited
Loading

What would you like to be added:
add comments for File API in proto files .
For example, add comments for code below:
image

Why is this needed:

chinese:
为 proto 文件中file API 相关接口 补充注释.
有了更多注释后，可以用工具根据注释生成文档
@seeflood seeflood added good first issue Good for newcomers help wanted Extra attention is needed kind/comments kind/easy labels Jun 14, 2022
@seeflood seeflood changed the title add comments for File API in proto files add comments for File API in proto files 给 proto 代码添加注释 Jun 14, 2022
@seeflood seeflood changed the title add comments for File API in proto files 给 proto 代码添加注释 add comments for File API in proto files; 给 proto 代码添加注释 Jun 15, 2022
@Kelei0215 Kelei0215 mentioned this issue Jun 15, 2022
Open
@XiaoYaoheihei
Copy link

Maybe I can help to add, could you assign it to me?
Thank you!

@seeflood
Copy link
Member Author

@XiaoYaoheihei Sure, thanks!

@XiaoYaoheihei
Copy link

Do I need to provide comments for the .proto files of all branches, I see that the .proto files of the master branch have been completed.

@wenxuwan
Copy link
Member

wenxuwan commented May 17, 2023 •
edited
Loading

Do I need to provide comments for the .proto files of all branches, I see that the .proto files of the master branch have been completed.

master is ok. if master have comments, we can close this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@XiaoYaoheihei XiaoYaoheihei

Labels
good first issue Good for newcomers help wanted Extra attention is needed kind/comments kind/easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@wenxuwan @seeflood @XiaoYaoheihei