Skip to content

doc fix for onchain id event#751

Merged
ozgunozerk merged 1 commit into
mainfrom
rwa-onchain-id-event-fix
Jun 16, 2026
Merged

doc fix for onchain id event#751
ozgunozerk merged 1 commit into
mainfrom
rwa-onchain-id-event-fix

Conversation

@ozgunozerk

@ozgunozerk ozgunozerk commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Fixes #750

PR Checklist

  • Tests
  • Documentation

Summary by CodeRabbit

  • Documentation
    • Updated event documentation to clarify the structure of emitted event data.

@ozgunozerk ozgunozerk requested a review from bidzyyys June 16, 2026 08:05
@ozgunozerk ozgunozerk self-assigned this Jun 16, 2026
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8cd54f0f-f9db-4452-b458-68ca36a15af3

📥 Commits

Reviewing files that changed from the base of the PR and between 4114bb8 and 671c731.

📒 Files selected for processing (1)
  • packages/tokens/src/rwa/storage.rs

Walkthrough

A single documentation comment in set_onchain_id is corrected: the topics field for the token_onchain_id_updated event now shows onchain_id: Address instead of the outdated token_info topics shape.

Changes

Fix set_onchain_id event doc topics

Layer / File(s) Summary
Fix token_onchain_id_updated topics in set_onchain_id docs
packages/tokens/src/rwa/storage.rs
Replaces the stale token_info topics example with the correct onchain_id: Address entry in the inline event documentation for set_onchain_id.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A topic was wrong, a small little slip,
token_info had gone on a wayward trip.
Now onchain_id: Address stands proud and true,
The docs match the code — hooray, we're brand new!
✨ Hippity-hop, correctness restored!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change—a documentation fix for the onchain ID event, which aligns with the actual modification in the PR.
Description check ✅ Passed The PR description includes the required issue reference (#750), identifies the nature of the change (documentation fix), and marks the documentation checklist item as complete.
Linked Issues check ✅ Passed The PR successfully addresses issue #750 by updating the outdated event documentation for the onchain ID setter, bringing inline documentation into alignment with current implementation.
Out of Scope Changes check ✅ Passed All changes are scoped to fixing documentation in the storage function for the onchain ID event, with no unrelated modifications introduced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rwa-onchain-id-event-fix

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

@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.64%. Comparing base (4114bb8) to head (671c731).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #751   +/-   ##
=======================================
  Coverage   96.64%   96.64%           
=======================================
  Files          72       72           
  Lines        7610     7610           
=======================================
  Hits         7355     7355           
  Misses        255      255           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ozgunozerk ozgunozerk merged commit 031decc into main Jun 16, 2026
9 checks passed
@ozgunozerk ozgunozerk deleted the rwa-onchain-id-event-fix branch June 16, 2026 14:39
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.

RWA Onchain Setter event inline documentation discrepancy

2 participants