docs(configuration): adjust wording and improve clarity #766
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
bernardcooke53
merged commit 6b2fc8c
into
python-semantic-release:master
8 checks passed
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.
Purpose
Update mis-spelled words and adjust wording for clarity
Rationale
I adjusted the environment variable section a bit because if people don't read and just look for code blocks then we have an example in there that is not recommended and its not easy to tell its not recommended. I recommend we just eliminate that example completely but state it clearly that it should not be done that way.
Other items were just clarity of language. Feel free to pass feedback if my wording is not clear either.