Use PEP8 names #84
Merged
Use PEP8 names #84
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
Per https://peps.python.org/pep-0008/#package-and-module-names > Modules should have short, all-lowercase names. Underscores can be > used in the module name if it improves readability. Python packages > should also have short, all-lowercase names, although the use of > underscores is discouraged.
PEP8 says: Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. https://peps.python.org/pep-0008/#package-and-module-names
See https://peps.python.org/pep-0008/#constants: > Constants are usually defined on a module level and written in all > capital letters with underscores separating words. Examples include > MAX_OVERFLOW and TOTAL.
Closed
YufengXin
approved these changes
Jan 6, 2023
Closed
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.
Issue is #61, and here's PEP8 for reference: https://peps.python.org/pep-0008/
These are the changes:
sdx.pce.LoadBalancing.TE_Solver.pyhave been renamed tosdx.pce.load_balancing.te_solver.py, following the convention that module names should be in lowercase.TE_Solverclass is nowTESolver, following the PEP8 recommendation that class names should follow CapWords convention.Test_TE_Solverclass isTESolverTests.sdx.pce.Utilityand the files inside of it have been similarly renamed.sdx.pce.Utilities.global_names.pyhas been renamed tosdx.pce.utils.constants.py, because the latter name is a little more accurate.Constantsclass.