Chore: Update description for get_subscriptions method #27
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
cellomatt
reviewed
Mar 21, 2024
| @@ -453,8 +453,8 @@ def list_subscriptions(self, collection, id, options={}): | |||
|
|
|||
| def get_subscriptions(self, collection, id, options={}): | |||
| """ | |||
| Returns subscriptions for an object as a recipient | |||
|
|
|||
| Returns all of the active subscriptions that the specified object is subscribed to (not the subscribers of the object) | |||
There was a problem hiding this comment.
Suggested change
| Returns all of the active subscriptions that the specified object is subscribed to (not the subscribers of the object) | |
| Returns all of the active subscriptions for which the specified object is a recipient |
I think maybe with this word-smithing, the "not the subscribers..." part could be left out? But no strong feelings about that part.
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.
Updates the description for the
get_subscriptionsmethod, as it's unclear that the method uses the?mode=recipientquery parameter, thus returning a list of active subscriptions that the specified object itself is subscribed to (not returning a list of recipients who are subscribed to that object, which is what thelist_subscriptionmethod accomplishes).