Add -Ycook-comments to cook comments #4574
Merged
+7 −2
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 commit adds the
-Ycook-commentsoption that will enable cookingof the comments (type checking of
@usecasein docstrings, expansion of@defineand@inheritdoc, etc.)There are two reasons for introducing this configuration option:
are not interested in cooking them.
-Ycheck, which prevents us fromenabling
-Ykeep-commentsby default.