Replace single- with double-quote for docstrings, as per PEP-257 #973
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.
Related Issue(s):
Closes #319
Proposed Changes:
For inclusion in changelog (if applicable):
Not intended for changelog:
'''
with"""
in order to comply with PEP-257 as outlined in change docstrings to triple quotes #319Diff of User Interface
Old behavior: No diff
New behavior: No diff
PR Checklist:
(Optional) @mentions for Notifications:
Remark
I was looking for a small/easy issue to start with and found #319. However, after browsing through the code base, I couldn't find any docstrings that used only a single (opposed of triple) quote (please let me know if there are yet any and I simply overlooked them). Thus, technically the description of #319:
is already fulfilled. However PEP-257 requires triple-double quotes
which is why I took the liberty to tackle this exact specification in the scope of the linked issue. Basically, all I did was to find and replace
'''
with"""
throughout the code base.Note, I would totally understand if you do not want to take care of such a cosmetic change.
Please review with care, as this is my first contribution to this repo. Thanks!