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

docstring #141

Merged
merged 10 commits into from
Aug 1, 2023
Merged

docstring #141

merged 10 commits into from
Aug 1, 2023

Conversation

YufengXin
Copy link
Collaborator

#70.

@sajith already made the constant flag name change.
Used docstring in a few places

@YufengXin
Copy link
Collaborator Author

black reformatting is different in 3.8 (my Mac) and 3.9 (here)?

@YufengXin
Copy link
Collaborator Author

updated my MacOS to Python3.11

Copy link
Member

@sajith sajith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I have some suggestions about locations of the docstrings. (This PEP might be useful: https://peps.python.org/pep-0257/.)

Not sure the suggestions will be formatted correctly if you accept them, because I made them with GitHub's interface. You might need to run black again.

Please make sure that you have the current version of black, with pip install --upgrade black. (We should probably pin black at the current major version...)

There probably are other things too that we can do (documenting parameters, following suggestions made by pydocstyle etc) but this is a good change. :-)

YufengXin and others added 7 commits August 1, 2023 10:50
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
Co-authored-by: Sajith Sasidharan <sajith@hcoop.net>
@YufengXin
Copy link
Collaborator Author

Thanks. Fixed. I've updated all the tools after Python upgrade yesterday

@YufengXin YufengXin merged commit 9c87adc into main Aug 1, 2023
@YufengXin YufengXin deleted the 70.randomTopology branch August 1, 2023 15:10
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.

2 participants