fix(contracts): exclude yield storage layout from docgen#3065
Open
kyzooghost wants to merge 1 commit into
Open
fix(contracts): exclude yield storage layout from docgen#3065kyzooghost wants to merge 1 commit into
kyzooghost wants to merge 1 commit into
Conversation
Contributor
linea-besu Changelog Preview (informational)[Unreleased] diff (commits touching
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3065 +/- ##
=========================================
Coverage 77.19% 77.19%
Complexity 7003 7003
=========================================
Files 1121 1121
Lines 44508 44508
Branches 5355 5355
=========================================
Hits 34356 34356
Misses 8785 8785
Partials 1367 1367
*This pull request uses carry forward flags. Click here to find out more. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR implements issue(s) # N/A
Summary
Excludes
YieldManagerStorageLayout.solfrom Solidity docgen output so docgen no longer evaluates the audited storage helper NatSpec that uses$/$$return variable names. This keeps audited Solidity untouched and fixes thesolidity-docgenparser crash.Verification
cd contracts && pnpm exec hardhat docgenpnpm -F contracts run solidity:docgenpnpm -F contracts run lint:tsChecklist
Note
Low Risk
Low risk tooling/config change that only affects generated Solidity documentation output. No contract logic or deployment behavior is modified.
Overview
Updates
contracts/hardhat.config.tsto excludeyield/YieldManagerStorageLayout.solfromsolidity-docgengeneration, avoiding docgen processing/parsing of that audited storage-layout helper and preventing docgen crashes.Reviewed by Cursor Bugbot for commit 75729f8. Bugbot is set up for automated code reviews on this repo. Configure here.