The godoc throughout much of the project is incorrect, leading to IDEs such as VsCode not showing documentation unless the comment (accidentally?) starts with the correct identifier name. For example, when I'm creating a consumer, I can't see anything about what the different fields in pulsar.ConsumerOptions. For example, Topic shows nothing:
because the godoc at the definition (which is very useful), does not start with the string Topic:
Whereas pulsar.Shared does:
Because the comment happens to begin with the string Shared
Original Issue: apache/pulsar-client-go#652
The godoc throughout much of the project is incorrect, leading to IDEs such as VsCode not showing documentation unless the comment (accidentally?) starts with the correct identifier name. For example, when I'm creating a consumer, I can't see anything about what the different fields in
because the godoc at the definition (which is very useful), does not start with the string 
pulsar.ConsumerOptions. For example,Topicshows nothing:Topic:Whereas
Because the comment happens to begin with the string 
pulsar.Shareddoes:Shared