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

GoDoc chose comment generated by protobuf as package documentation #48

Closed
3 tasks
at15 opened this issue May 31, 2017 · 1 comment
Closed
3 tasks

GoDoc chose comment generated by protobuf as package documentation #48

at15 opened this issue May 31, 2017 · 1 comment
Projects
Milestone

Comments

@at15
Copy link
Member

at15 commented May 31, 2017

i.e.

So the fact is, godoc put all the top comments as package level comment, but code generated by protobuf use /* indent ... */ so it got highlighted. It's not a problem for normal usage of protobuf since they might be in a package of its own, while for xephon-k, we use struct generated by protobuf directly.

One solution is to automatically remove the comment and only keep the DO NOT EDIT. Btw: the DO NOT EDIT for generated double series is also shown in package level comment.

  • remove protobuf comment
  • remove DO NOT EDIT for double series in godoc (not in source code)
  • add example (I think I have created a similar issue somewhere since golang support run in doc https://blog.golang.org/examples )

In general, current godoc is a mess ...

@at15 at15 added the bug label May 31, 2017
@at15 at15 added this to the 0.4.0 milestone May 31, 2017
@at15 at15 added this to TODO in API via automation Feb 16, 2018
@at15
Copy link
Member Author

at15 commented Feb 16, 2018

Close in favor of #60

Should use a dedicated for protobuf generated package, i.e. xephonkpb

@at15 at15 closed this as completed Feb 16, 2018
API automation moved this from TODO to DONE Feb 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
API
  
DONE
Development

No branches or pull requests

1 participant