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

no more generated package doc #528

Merged
merged 3 commits into from
Feb 22, 2018
Merged

no more generated package doc #528

merged 3 commits into from
Feb 22, 2018

Conversation

jhump
Copy link
Contributor

@jhump jhump commented Feb 22, 2018

This would resolve #413. It relies on a flag that can be passed to protoc-gen-go.

@dsnet
Copy link
Member

dsnet commented Feb 22, 2018

\cc @neild. We were discussing just removing this all together.

@neild
Copy link
Contributor

neild commented Feb 22, 2018

The package doc comment is pretty useless at the moment. I can see a case for just removing it. I don't really have a strong opinion one way or the other, although I think I'd rather get rid of it always than add another knob.

@jhump jhump changed the title flag to turn off generated package doc no more generated package doc Feb 22, 2018
@jhump
Copy link
Contributor Author

jhump commented Feb 22, 2018

@neild, how does it look now?

@jhump jhump force-pushed the jh/package-docs branch 2 times, most recently from 2bba5d3 to 1724048 Compare February 22, 2018 14:44
@paranoiacblack
Copy link
Contributor

+1 to getting rid of this

@neild
Copy link
Contributor

neild commented Feb 22, 2018

CL looks fine to me, I'll leave it up to @dsnet to decide whether we actually want to do this or not.

@dsnet
Copy link
Member

dsnet commented Feb 22, 2018

I vote to remove it as well.

As it currently stands, it:

  • provides no useful information. The list of .proto files is not particularly useful for the end user and the list of top-level messages is redundant with the godoc index.
    • One could argue that the index is overly-verbose because it contains other identifiers like: sub-messages (these sort nicely as they have the parent as a prefix), enums, grpc stubs, and oneof wrappers (it's unfortunate that we generate so many of these). If we did end up wanting to clean this up, perhaps use of per-file godoc sections is probably better to segregate the index so that all the oneof wrappers appeared at the end.
  • actually conflicts with users who desire to put their own hand-written package documentation (which is almost always going to be more informative than what we can generate).

@neild neild merged commit efae459 into golang:dev Feb 22, 2018
@golang golang locked and limited conversation to collaborators Jun 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants