Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleans up macro code, fixes example usage, fixes minor typos and adds linting to comply with official PEP-8 standards #84

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

smithbh
Copy link

@smithbh smithbh commented Jan 3, 2025

In addition to fixing the minor bugs, I had already fixed the formatting issues from my previous pull request and cleaned up the implementation.

In addition to these changes, I also used linting tools to make checker_3.py PEP-8 compliant, which is the official Python 3 formatting standard defined by Guido van Rossum himself. Although it was unsolicited, implementing this standard helps make it both easier to and more likely that others will contribute!

Note: make sure the screen has sufficient width when comparing the utility title macro/release version banner and the notice/disclaimer banner that displays upon successful scans.

This commit resolves the formatting issues in my previous pull request, fixes minor typos, and fixes the example usage which was missing the python command.

Signed-off-by: Brandon Smith <[email protected]>
# Conflicts:
#	PyPS3checker/checker_py3.py

- Improves code readability using official python PEP-8 standards
- Fixes minor typos
- Fixes usage example by adding the python command

Signed-off-by: Brandon Smith <[email protected]>
Standardizing format with the official python linting standards increases the ease and likelihood of additional contributions from the community

Signed-off-by: Brandon Smith <[email protected]>
@smithbh
Copy link
Author

smithbh commented Jan 3, 2025

Oops, forgot to add links to additional PEP-8 resources:

Blank lines for top-level function definitions

PEP 8 – Style Guide for Python Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant