Reformat docstring #670
Merged
Reformat docstring #670
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
jeffwecan
approved these changes
Feb 8, 2021
jeffwecan
added
misc
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 PR simply reformats a single docstring to be < 100 characters and look nicer.
The motivation for this is that we clone this repo in StackStorm-Exchange/stackstorm-vault (see PR: StackStorm-Exchange/stackstorm-vault#19), but the line limit on our flake8 checks is only 100 characters, and when flake8 checked this file, the build failed (CircleCI result) due to that.
We are tweaking our test setup script so that flake8 ignores the clone of hvac (see StackStorm-Exchange/stackstorm-vault#20), in an effort to decouple the formatting settings of this repo with our own. But I also figured that you might be interested in a small but nice docstring fixup. Everybody likes nicely formatted code, right? 馃槃
Anyway, thanks for your consideration on this, and thank you for this wonderful library!