-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change the messageText and messageId order for updateMessage #4458
Comments
In .NET we have public virtual async Task<Response<UpdatedMessage>> UpdateMessageAsync(
string messageText,
string messageId,
string popReceipt,
TimeSpan visibilityTimeout = default,
CancellationToken cancellationToken = default) which puts I have no problem making this change if other languages would like to. |
In Python, we have |
JS version - similar to python // * @memberof MessageIdClient
public async update(
popReceipt: string,
message: string,
visibilityTimeout?: number,
options: MessageIdUpdateOptions = {}
): Promise<Models.MessageIdUpdateResponse> |
XStore team agrees that we should have the same order of parameters on these. The slight preference is towards this ordering: messageText, popReceipt, visibilityTimeout, options. This seems to order them by most used to least used. |
When I raised this with Sima, it was related to my preference that method arguments flow from arguments that identify the object to perform the operation on, and then to follow that with the values to provide to the object. In this way, it reads out as "update messageID / popReceipt to have a messageText as specified". Currently it reads "update to messageText on messageID / popReceipt", which feels back to front. I have a very weak opinion on this though. |
Closing this as Java is consistent with .NET |
Proposed order: messageId, popReceipt, messageText, visibilityTimeout
See what the other languages are doing, if it is consistent talk with them and discussing this change
The text was updated successfully, but these errors were encountered: