Move wire_type() to Protobuf, create Protobuf.unknown_fields() type #375
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This type is referenced from the typespecs generated by the protoc extension. When building documentation for the protobufs (that is, using include_docs=true), it can't be resolved and ex_doc will print the following warning for every struct: warning: documentation references type "Protobuf.Wire.Types.wire_type()" but it is hidden or private. By making it public, the warning is resolved, and it becomes clickable on hexdocs. Another alternative to solve the issue (while keeping the internal type private) would be to change the typespec of `:__unknown_fields__` to avoid referring to it, instead referring to a public type.
|
Maybe we should move the type instead? A module with a single type definition would look odd I think and we would have to |
|
Thanks, @ericmj, I agree. I just pushed another commit that moves it to |
v0idpwn
changed the title
ericmj
approved these changes
Oct 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This type is referenced from the typespecs generated by the protoc extension. When building documentation for the protobufs (that is, using include_docs=true), it can't be resolved and ex_doc will print the following warning for every struct:
warning: documentation references type "Protobuf.Wire.Types.wire_type()" but it is hidden or private.
By making it public, the warning is resolved, and it becomes clickable on hexdocs.
Another alternative to solve the issue (while keeping the internal type private) would be to change the typespec of
:__unknown_fields__to avoid referring to it, instead referring to a public type.