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

Extract Go comments from "main" package too #133

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vzxv
Copy link

@vzxv vzxv commented Feb 6, 2024

ExtractGoComments() uses the fully-qualified package path when creating keys in our CommentMap, but we perform lookups in that map using keys constructed using (reflect.Type)PkgPath(). The latter method always returns "main" for types defined in the "main" package, rather than a fully-qualified package path, so those lookups fail. The result is that we never incorporate comments into a schema for types defined in "main".

Update ExtractGoComments() to handle the special case of "main".

ExtractGoComments() uses the fully-qualified package path when creating
keys in our CommentMap, but we perform lookups in that map using keys
constructed using (reflect.Type)PkgPath(). The latter method always
returns "main" for types defined in the "main" package, rather than a
fully-qualified package path, so those lookups fail. The result is that
we never incorporate comments into a schema for types defined in "main".

Update ExtractGoComments() to handle the special case of "main".
@samlown samlown added the needs tests Not enough tests for this to be accepted label Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs tests Not enough tests for this to be accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants