Move to keyword only arguments to improve readability #94
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
|
This is in draft until we merge #93 as we need to fix the setup imports for the CI to function |
julianstirling
force-pushed
the
keyword-only-args
branch
from
3993627 to
e864d5b
Compare
New pylint allows you to seperately set a maximum number of total aguments and a maximum number of positional arguments. This gave us lots of warnings on the number of functions that had a confusingly high number of arguments. Rather than just up the limit in pylintrc it seems like good practice to make many of these arguments keyword only. This make code more clear, and more robust as we go forward.
julianstirling
force-pushed
the
keyword-only-args
branch
from
e864d5b to
92a0e89
Compare
|
Now #93 is merged we can get this in. |
jmwright
approved these changes
Oct 21, 2024
There was a problem hiding this comment.
@julianstirling Thanks for your work on this. I have noted files where I expect we'll end up with merge conflicts, but we'll just have to fix them when the time comes.
There was a problem hiding this comment.
We may end up with a merge conflict on this file since I've been working in it a lot on my other-shelves branch. I'll deal with it if it happens, but I expect it will.
There was a problem hiding this comment.
Same here as with fasteners.py. We'll probably end up with merge conflicts.
Merged
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.
New pylint allows you to seperately set a maximum number of total aguments and a maximum number of positional arguments. This gave us lots of warnings on the number of functions that had a confusingly high number of arguments.
Rather than just up the limit in pylintrc it seems like good practice to make many of these arguments keyword only. This make code more clear, and more robust as we go forward.