This repository was archived by the owner on Apr 8, 2026. It is now read-only.
proposal: consider using named key word arguments instead of **options#9
Closed
simonklee wants to merge 1 commit into
Closed
proposal: consider using named key word arguments instead of **options#9simonklee wants to merge 1 commit into
simonklee wants to merge 1 commit into
Conversation
…med key word arguments instead of undocumented **options kwargs
Contributor
|
Documenting the available options in the README would be my preferred option for now. Maybe in the next major version bump, move to named keyword arguments. |
Contributor
|
I'll get the available options documented in the README. |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
This commit does not implement the entire change, it's just an example. My issue is that you have to read the source code to use the **options. This pretty much is the case over the entire library. It gets even more confusing when you use parts of the options in one method, then pass the rest along to another.
Another option is to simply document the arguments.
Personally I'm not committed to either solution nor think they are very good — so if you have better suggestions I'm open for proposals.