Skip to content

docs: fix typo in API documentation - #2239

Open
meichuanyi wants to merge 1 commit into
minio:masterfrom
meichuanyi:docs-fix-api-typo
Open

docs: fix typo in API documentation#2239
meichuanyi wants to merge 1 commit into
minio:masterfrom
meichuanyi:docs-fix-api-typo

Conversation

@meichuanyi

@meichuanyi meichuanyi commented Jun 14, 2026

Copy link
Copy Markdown

Fixes a small typo in the API documentation: RecievedReceived.

This is a documentation-only change.

Summary by CodeRabbit

  • Documentation
    • Corrected spelling in API documentation for improved clarity.

Signed-off-by: meichuanyi <meichuanyi@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 28c596ab-da6f-48e6-9732-45cfbdc8cbea

📥 Commits

Reviewing files that changed from the base of the PR and between 291e83f and fb2d700.

📒 Files selected for processing (1)
  • docs/API.md

📝 Walkthrough

Walkthrough

A single-character spelling correction in docs/API.md changes "Recieved" to "Received" in the CancelBucketReplicationResync Return Values table description for the id field. No code or API signatures are modified.

Changes

API Documentation Typo Fix

Layer / File(s) Summary
Spelling correction in CancelBucketReplicationResync docs
docs/API.md
Fixes "Recieved" → "Received" in the id field description of the Return Values table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A bunny hopped through the docs one day,
And spotted a typo that had gone astray.
"Recieved?" it twitched, "That's just not right!"
One quick fix made the spelling bright.
Now "Received" stands proud, correct, and true! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix typo in API documentation' is concise and clearly describes the main change—a typo correction in API docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread docs/API.md
| `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|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
**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 |

@allanrogerr allanrogerr Aug 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@meichuanyi Please also fix this and resolve the conflict

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants