Skip to content

Add comment to readList and decodeList about aliasing#6342

Merged
ernestognw merged 4 commits intoOpenZeppelin:masterfrom
ernestognw:chore/RLP-decodeList-ref
Feb 11, 2026
Merged

Add comment to readList and decodeList about aliasing#6342
ernestognw merged 4 commits intoOpenZeppelin:masterfrom
ernestognw:chore/RLP-decodeList-ref

Conversation

@ernestognw
Copy link
Member

Fixes #????

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@ernestognw ernestognw requested a review from a team as a code owner February 10, 2026 18:21
@openzeppelin-security-agent
Copy link

The latest updates on your security scan. Learn more about OpenZeppelin Platform.

Project Scan Issues Details Updated
Openzeppelin Contracts 🟡 Queued View Feb 10, 2026, 6:21 PM (UTC)

@changeset-bot
Copy link

changeset-bot bot commented Feb 10, 2026

⚠️ No Changeset found

Latest commit: 6675c6e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2026

Walkthrough

Documentation updates added to RLP.sol for the readList and decodeList functions. The documentation clarifies that these functions operate on memory slices and that the returned arrays contain references to the original payload rather than copied bytes. The changes consist of inline documentation only, with no modifications to the actual function implementations or public declarations.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description uses the PR template but is essentially empty with no substantive content about the changes, though the title and summary provide context about the aliasing comments being added. Fill in the PR description with details about why the aliasing comments are needed and what they clarify about the function behavior.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding comments about aliasing to the readList and decodeList functions.
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 unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

@ernestognw ernestognw added this to the 5.6 milestone Feb 10, 2026
ernestognw and others added 2 commits February 11, 2026 10:24
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Amxx
Amxx previously approved these changes Feb 11, 2026
@ernestognw ernestognw merged commit becf082 into OpenZeppelin:master Feb 11, 2026
21 checks passed
Amxx added a commit that referenced this pull request Feb 12, 2026
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants