Save module docstring to top of pyi files #385
Merged
Conversation
This file contains hidden or 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
|
If you add some module docstrings to the top of |
nipunn1313
reviewed
Jul 21, 2022
mypy_protobuf/main.py
Outdated
Comment on lines
840
to
841
| if not self._write_comments([d.FileDescriptorProto.SYNTAX_FIELD_NUMBER]): | ||
| self._write_comments([d.FileDescriptorProto.PACKAGE_FIELD_NUMBER]) |
There was a problem hiding this comment.
I'd think you'd want to print comments for both here?
Suggested change
| if not self._write_comments([d.FileDescriptorProto.SYNTAX_FIELD_NUMBER]): | |
| self._write_comments([d.FileDescriptorProto.PACKAGE_FIELD_NUMBER]) | |
| self._write_comments([d.FileDescriptorProto.SYNTAX_FIELD_NUMBER]) | |
| self._write_comments([d.FileDescriptorProto.PACKAGE_FIELD_NUMBER]) |
mypy_protobuf/main.py
Outdated
| # HACK: convert single-line docstring to multiline | ||
| if self.lines[1].endswith('"""'): | ||
| self.lines[1] = self.lines[1][:-3] | ||
| self._write_line('"""') |
There was a problem hiding this comment.
Still a hack, but here's a different idea for a hack to get this to work without too much factoring and line fudging.
Remove the inner triple quotes from HEADER and then try:
saved_lines = self.lines
self.lines = []
self._write_comments([d.FileDescriptorProto.SYNTAX_FIELD_NUMBER])
self._write_comments([d.FileDescriptorProto.PACKAGE_FIELD_NUMBER])
if self.lines:
assert self.lines[0].startswith('"""')
lines[0] = f'"""{HEADER}{lines[0][3:]}'
else:
self._write_line(f'"""{HEADER}"""')
nipunn1313
force-pushed
the
module-docstring
branch
from
c864cac to
64d1955
Compare
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 attempts to save javadoc-like comments as a module docstring to the top of the pyi files.
I love using this project with Sphinx and this was just a piece of missing information that I want to have exposed, especially since I leave tons of documentation about usage at the top of my protobuf files.
I will take a look at tests if this implementation looks okay (I don't want to overstep and rewrite some of the helper functions to be more elegant to this kind of change).