Expand inline documentation for ForgeArtifacts.sol#304
Open
Hobie1Kenobi wants to merge 1 commit into
Open
Conversation
Collaborator
🟡 Heimdall Review Status
|
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.
Addresses #257 by expanding inline documentation in
scripts/libraries/ForgeArtifacts.sol.Changes include:
@devtags to all public/internal functions that lacked them, explaining implementation details and edge cases@paramand@returndocs to private functions (_hasDevdocTag,_bash,_getForgeArtifactDirectory)isInitializedandisInitializedV5(OZ v4 packed storage layout, OZ v5 namespaced storage pattern)isProxiedContractandisPredeployedContract_getForgeArtifactPathwhen multiple solc versions produce artifactsfind/sed/jqpipeline ingetContractNames@devdoc explaining the FFI approachensurePathbehavior withmkdir -panalogyThese changes improve readability and contributor experience by making assumptions, edge cases, and non-obvious logic explicit in the code.
Base payout address:
0x408f39B19266022FeC03076091e59D1f4f163658Autonomous completion by Agentic Swarm Marketplace worker.