Skip to content

docs: clarify wording in subscriptions regarding starting positions#379

Merged
w1am merged 1 commit intotrunkfrom
w1am/fix-docs
Mar 4, 2026
Merged

docs: clarify wording in subscriptions regarding starting positions#379
w1am merged 1 commit intotrunkfrom
w1am/fix-docs

Conversation

@w1am
Copy link
Contributor

@w1am w1am commented Mar 4, 2026

No description provided.

@w1am w1am added documentation Improvements or additions to documentation cherry-pick:release/v1.0 cherry-pick:release/v1.1 labels Mar 4, 2026
@qodo-code-review
Copy link

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Review Summary by Qodo

Clarify subscription position semantics in documentation

📝 Documentation

Grey Divider

Walkthroughs

Description
• Clarify that events are read "after" the subscribed position
• Emphasize that subscription positions are exclusive with bold formatting
Diagram
flowchart LR
  A["Subscription Position Docs"] -- "Clarify 'after' wording" --> B["Events after position"]
  A -- "Bold 'exclusive' keyword" --> C["Emphasize exclusivity"]
Loading

Grey Divider

File Changes

1. docs/api/subscriptions.md 📝 Documentation +2/-2

Clarify subscription position semantics and exclusivity

• Changed "at the position" to "after the position" for clarity on event reading behavior
• Added bold formatting to the word "exclusive" to emphasize subscription position semantics
• Improved documentation accuracy regarding how subscription positions work

docs/api/subscriptions.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link

qodo-code-review bot commented Mar 4, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

@w1am w1am merged commit 6f085c3 into trunk Mar 4, 2026
1 check passed
@w1am w1am deleted the w1am/fix-docs branch March 4, 2026 11:56
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

@w1am 👉 Created pull request targeting release/v1.0: #380

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

@w1am 👉 Created pull request targeting release/v1.1: #381

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant