Fixing typo's in the pySCG main readme #793
Open
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
Signed-off-by: Helge Wehder <[email protected]>
|
|
||
| __Code file naminng conventions:__ | ||
| __Code file naming conventions:__ | ||
|
|
||
| * `noncompliantXX.py` anti-pattern. |
There was a problem hiding this comment.
Anti pattern could be a foreign concept to beginners. I would suggest changing this to:
noncompliantXX.py: anti-pattern (bad programming practice).
As this describes to the user what exactly is within the file, and also will teach them what the term anti-pattern means, without having to go to google straight away.
Signed-off-by: Helge Wehder <[email protected]>
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.
No description provided.