actions [nfc]: Namespace actions as statics on a ZulipAction class, and document #1366
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
This makes it explicit at each call site that the method being called is an action, not (for example) an API endpoint binding. The difference is important in particular because it affects how -- really, whether -- the caller should handle errors. See discussion from when the similarity in appearance to API endpoint bindings caused confusion: https://chat.zulip.org/#narrow/channel/516-mobile-dev-help/topic/.23F1317.20showErrorDialog/near/2080570
Like the previous commit, this hopefully helps avoid confusion about the role of these methods when looking at their call sites.
chrisbobbe
force-pushed
the
pr-actions
branch
from
0341cbc to
a198f72
Compare
|
Thanks, LGTM! 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.
This makes it explicit at each call site that the method being called
is an action, not (for example) an API endpoint binding. The
difference is important in particular because it affects how --
really, whether -- the caller should handle errors.
See discussion from when the similarity in appearance to API endpoint
bindings caused confusion:
https://chat.zulip.org/#narrow/channel/516-mobile-dev-help/topic/.23F1317.20showErrorDialog/near/2080570
Also document the two methods here (other than the private helper) that didn't already have docs.