Be more lenient about isolated docstrings in the QMP spec. #145
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
Recent revisions of the spec have added more general documentation (good!), but those are tripping up the code generator as potential rogue datatype docstrings (bad!). In practice, we still have a safety in place for that, because we refuse to codegen a type definition that doesn't have a docstring. So, we can safely ignore orphan docstrings, as long as we don't ignore orphan definitions.
benlemasurier
approved these changes
Feb 1, 2017
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.
Recent revisions of the spec have added more general documentation
(good!), but those are tripping up the code generator as potential
rogue datatype docstrings (bad!).
In practice, we still have a safety in place for that, because we
refuse to codegen a type definition that doesn't have a docstring.
So, we can safely ignore orphan docstrings, as long as we don't
ignore orphan definitions.