Skip to content

Fix broken NatSpec cross-references in Account and AccessManager#6526

Open
akhilesharora wants to merge 2 commits into
OpenZeppelin:masterfrom
akhilesharora:fix/natspec-xrefs
Open

Fix broken NatSpec cross-references in Account and AccessManager#6526
akhilesharora wants to merge 2 commits into
OpenZeppelin:masterfrom
akhilesharora:fix/natspec-xrefs

Conversation

@akhilesharora
Copy link
Copy Markdown

@akhilesharora akhilesharora commented May 16, 2026

{entrypoint} and {executed} currently render as literal text on docs.openzeppelin.com instead of resolving to links, because solidity-docgen does case-sensitive cross-reference lookup.

In contracts/account/Account.sol:

  • function declared at line 52: function entryPoint() public view virtual returns (IEntryPoint)
  • wrong-cased xref {entrypoint} at lines 118, 128, 138

In contracts/access/manager/AccessManager.sol:

  • function declared at line 503: function execute(address target, bytes calldata data)
  • typo xref {executed} at line 725 (matches no symbol; six other docblocks in the same file already use {execute})

Doc-only fix, no compiled code touched. Ran npm test locally on the fix branch: 7653 passing, 0 failing.

Before:

* @dev Sends the missing funds for executing the user operation to the {entrypoint}.
* @dev Returns true if a call with `target` and `selector` is being executed via {executed}.

After:

* @dev Sends the missing funds for executing the user operation to the {entryPoint}.
* @dev Returns true if a call with `target` and `selector` is being executed via {execute}.

PR Checklist

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

@akhilesharora akhilesharora requested a review from a team as a code owner May 16, 2026 22:55
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 16, 2026

🦋 Changeset detected

Latest commit: 0ac6bd8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 16, 2026

Review Change Stack

Walkthrough

This PR contains purely documentation corrections across two contracts. AccessManager's _isExecuting NatSpec comment is updated to correctly reference the {execute} function instead of {executed}. Account.sol's NatSpec comments for _payPrefund, _checkEntryPoint, and _checkEntryPointOrSelf are updated to standardize {entryPoint} casing from lowercase {entrypoint}. No Solidity logic, interfaces, state, or function behavior is changed.

Suggested labels

ignore-changeset

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately and concisely describes the main change: fixing broken NatSpec cross-references in the Account and AccessManager contracts.
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.
Description check ✅ Passed The PR description clearly explains the NatSpec cross-reference fixes in both files with specific line numbers, before/after examples, and confirms no compiled code was touched.

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

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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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.

1 participant