Improve style consistency in root directory docs files #4493
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
Nikolaj-K
commented
May 10, 2021
| @@ -1,4 +1,4 @@ | |||
| # Github actions template config | |||
| # Github actions template config. | |||
There was a problem hiding this comment.
A lot of those are just because, for example 4 lines below, the dot is used.
There was a problem hiding this comment.
Btw. all these values not intended to be changed at runtime, i.e. python "constants", should be capitalized.
Nikolaj-K
commented
May 10, 2021
| windows = True | ||
| else: | ||
| windows = False | ||
| windows = len(sys.argv) > 1 and "win" in sys.argv[1] # Special case windows to 0.1.6225 |
There was a problem hiding this comment.
iirc this is the only change that's not in a doc or echo statement.
lodenrogue
previously approved these changes
May 10, 2021
hoffmang9
previously approved these changes
May 11, 2021
|
Fixed the black test, was about removing a blank. |
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.
Read through the files in the root directory and where I saw that various conventions where mixed or sentences could be completed, made some edits. When in doubt I opted for the "more full sentence" conventions with dots at the end and all.
Some hyperlinks are added too.