docs: clarify update messaging endpoints only work for draft messages#11656
docs: clarify update messaging endpoints only work for draft messages#11656sanzofr wants to merge 1 commit intoappwrite:1.9.xfrom
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (3)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR adds a blockquote note to the Confidence Score: 4/5Safe to merge; the change is purely additive documentation and introduces no functional risk, though the note is redundant with existing text. Only documentation files are touched, so there is zero risk of a runtime regression. The sole concern is that the added note duplicates information already present in each file's first line. This is a minor quality issue worth addressing before merging to avoid reader confusion, but it does not block the PR. All three files (update-email.md, update-push.md, update-sms.md) have the same redundancy; no file poses a technical risk. Important Files Changed
Reviews (1): Last reviewed commit: "docs: clarify update messaging endpoints..." | Re-trigger Greptile |
| @@ -1 +1,3 @@ | |||
| Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated. | |||
|
|
|||
| > Note: This endpoint only works for messages in draft status. | |||
There was a problem hiding this comment.
Redundant note — same information already in line 1
The first line of this file already states: "This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated."
The added blockquote repeats the exact same constraint. Rather than duplicating it, consider either removing the blockquote or rewriting line 1 to be a shorter description and keeping only the blockquote for emphasis. The same redundancy applies to docs/references/messaging/update-push.md:3 and docs/references/messaging/update-sms.md:3.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
What does this PR do?
This PR updates the documentation for the
updateEmail(),updatePush(), andupdateSms()endpoints to clarify that they only work when the message is in draft status.Currently, this behavior is not clearly mentioned in the docs, which may lead to confusion when the endpoints do not work as expected on non-draft messages.
Test Plan
Related PRs and Issues
Checklist