Repository navigation
fix(docs): associate each contract with its own artifact - #706
Closed
fengxueweilai wants to merge 1 commit into
Closed
fengxueweilai wants to merge 1 commit into
fengxueweilai wants to merge 1 commit into
Conversation
Signed-off-by: fengxueweilai <fengxueweilai@outlook.com>
Author
|
Hi @brickpop, would you mind taking a look at this PR when you have a chance? It touches the current Foundry-based project structure, so I thought you might be the right person to ask. The change itself is kept small and isolated. Happy to revise it if there’s a better way to fit the current OSx structure. Thanks! |
Contributor
|
Hi @fengxueweilai, thank you for contributing :) Your PR landed exactly at the point where we start retiring each repo's individual documentation, in favor of the unified knowledge base: Unfortunately, the PR cannot land here, as |
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.
Description
Fixes #707
Foundry emits a separate artifact for each contract while including the complete source AST in each one. The docs loader associates every contract node with every artifact, so a source containing two contracts can lose one contract or use the wrong documentation metadata.
Only associate a ContractDefinition with the artifact whose filename matches the contract name. Add a fixture with two contracts sharing one source AST and distinct devdoc metadata.