-
-
Notifications
You must be signed in to change notification settings - Fork 22
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
Chore/style cleanup utility functions #80
Chore/style cleanup utility functions #80
Conversation
… global convenience variables where appropriate
…hance docstrings.
…mize config handling, and refine docstrings.
…__.py that fails ruff formatting
…__.py that fails ruff formatting
@Schefflera-Arboricola -- all type annotations have now been removed. If there are no other issues, then it might be helpful for us to get this merged sooner rather than later so that I can begin working on some of the other features that we discussed. WDYT? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't feel strongly about any of these comments, but these are some suggestions for choices during the style cleanup.
Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Dan Schult <dschult@colgate.edu>
Thank you so much for the review! I've committed your formatting suggestions and agree with all of your comments. |
What is the program that is creating the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we're getting bogged down here in linting land... :(
Can we change the .gitignore
file in a separate PR?
I like the changes here to the functions and the tests. Its the style changes that I'm having trouble with.
Co-authored-by: Dan Schult <dschult@colgate.edu>
Yes, happy to revert the .gitignore to |
The Local History extension of VScode creates .history folders to store automatic backups of your files so you can revert to previous versions, similar to how PyCharm's Local History works. For now, I can say that if the preference is to be more conservative with what goes into the .gitignore file, then it is no problem for me to just use my local |
…tions' into chore/style-cleanup-utility-functions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is basically ready to go as far as I'm concerned.
There are some comments below.
@MridulS -- it seems like removing the ruff dependency with that direct push to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I approve these changes.
@Schefflera-Arboricola can you re-take a look?
Can you try moving the update-get-info precommit hook at the end in for future refernce - CI error msg : |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary
This PR focuses on stylistic improvements and cleanup of utility functions.
Goal
Ensure better package maintainability, scalability, and ease of contribution for new developers.
Code Style Adjustments
Utility Function Cleanup
@assign_algorithms
decorator to dynamically assign algorithms toBackendInterface
, reducing manual updates and boilerplate.BackendInterface
by replacing explicit algorithm declarations with automatic mapping from theALGORITHMS
list.ALGORITHMS
could be obviated by dynamically retrieving algorithm names directly from the modules using introspection (__str__
,dir()
, or__dict__
), which might be too "auto-magical" for now but worth considering for a future PR.ParallelGraph
's readability and consistency.Removal of Unused Imports/Code
@dPys