docs: correct delete_obj_default_permissions sig#1483
Merged
jacalata merged 1 commit intotableau:gh-pagesfrom Oct 11, 2024
Merged
docs: correct delete_obj_default_permissions sig#1483jacalata merged 1 commit intotableau:gh-pagesfrom
jacalata merged 1 commit intotableau:gh-pagesfrom
Conversation
Closes tableau#1241 The docs were incorrect as to what arguments delete_*_default_permissions accepted. This corrects the docs to show that the methods accept an object and not an iterable of objects.
e273d95 to
53bb858
Compare
jacalata
approved these changes
Oct 11, 2024
Contributor
jacalata
left a comment
There was a problem hiding this comment.
Very nice. Do you think it's worth updating the code to add list handling, or is one at a time enough for most use cases?
Contributor
Author
|
I am conflicted on that. It could be worth doing, but the underlying endpoint only supports one permission at a time. So it would be "hiding" multiple calls being made. I think the user performing the call in a loop is simple enough. It may still be desired to support accepting a list from the perspective of method symmetry though. |
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 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.
Closes #1241
The docs were incorrect as to what arguments
delete_*_default_permissions accepted. This corrects the docs to show that the methods accept an object and not an iterable of objects.