Natspec #395
Merged
Natspec #395
Conversation
This file contains 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.
What I did
Add
Contract.infoandContractTx.infomethods to view NatSpec documentation in the console.Closes #378
How I did it
brownie.project.compiler.utils, themerge_natspecmethod combinesuserdocanddevdocinto a single dict, which is included in the build artifact for each contract.brownie.network.contract, the_print_natspecconverts the natspec dict into human readable form and outputs to stdout.How to verify it
Run tests. I added new cases, including checks against solc
v0.5.0(single return field) andv0.6.0(multiple return fields) as well a vyper.Checklist