docs: fix typo in API documentation - #2239
Conversation
Signed-off-by: meichuanyi <meichuanyi@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA single-character spelling correction in ChangesAPI Documentation Typo Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
| | `tgtArn` | *string* | Target Amazon Resource Name | | ||
|
|
||
| **Return Values** |Param |Type |Description | |:---|:--|:---| |`id`|*string*| Recieved upon successful cancellation of replication resync| |`err`| *error*| Standard Error| | ||
| **Return Values** |Param |Type |Description | |:---|:--|:---| |`id`|*string*| Received upon successful cancellation of replication resync| |`err`| *error*| Standard Error| |
There was a problem hiding this comment.
This table is collapsed onto a single line, so it renders as a paragraph of literal pipe characters instead of a table — it's the only one of the file's 46 Return Values sections written this way (compare lines 2299–2303 just above). Since this line is already being edited, expanding it to the block form the neighboring sections use lets the corrected text actually render as a table.
| **Return Values** |Param |Type |Description | |:---|:--|:---| |`id`|*string*| Received upon successful cancellation of replication resync| |`err`| *error*| Standard Error| | |
| **Return Values** | |
| | Param | Type | Description | | |
| |:------|:---------|:------------------------------------------------------------| | |
| | `id` | *string* | Received upon successful cancellation of replication resync | | |
| | `err` | *error* | Standard Error | |
There was a problem hiding this comment.
@meichuanyi Please also fix this and resolve the conflict
Fixes a small typo in the API documentation:
Recieved→Received.This is a documentation-only change.
Summary by CodeRabbit