This repository was archived by the owner on Aug 7, 2024. It is now read-only.
Consistency in keyword arguments for "id" parameters #314
Conversation
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
"status_id" is more common within the api, but there are a couple methods that use "id" to spec the same thing, which is confusing and inconsistent. "woeid" avoids shadowing a builtin, but is also more expressive.
Owner
|
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 changes some of the keyword arguments so that they are a little more consistently named in the API and avoid renaming the builtin function
id. Kind of a small change, but I wanted to get it in before v3. Basically anything that was passed asidhas a more descriptive argument now:idin the context of a Status object changes tostatus_id,message_idfor DirectMessages, andwoeidfor the Where On Earth ids. Similarly, for DestroyBlock, it's nowuser_idrather than justid.Documentation is included for everything here. All previous tests still pass, but some of the behavior is breaking since kwargs have been renamed.
I also noticed that
make cleankept deleting my vim undo files, so I hope no one minds that those are excluded from the target.Sound good, @bear?
This change is