ext.napoleon: Add aliases Warn and Raise #7888
Merged
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
tk0miya
requested changes
Jun 29, 2020
|
Thanks for the reminder, I completely forgot about that despite commenting about it in the linked issue 😄 |
tk0miya
approved these changes
Jun 29, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Add imperative aliases for Napoleon sections (Warn and Raise)
Feature or Bugfix
Feature
Purpose
In McSinyx/palace#109, we decided to follow PEP 257 guide on using imperative verbs in docstrings. While Return and Yield are now excepted as an alias for Returns and Yields respectively, Warn and Raise are yet to be recognized by Napoleon. This PR precisely add the aliases for these.
Detail
In Napoleon extension:
I couldn't found tests for aliasing these keys so I didn't provide any QA mechanism this patch.