Improved documentation for _preValidatePurchase method in Crowdsale #1101
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
nventuro
added
kind:improvement
documentation
|
Thanks! I noticed however you rolled back two typo fixes, and changed |
dougiebuckets
force-pushed
the
improve-documentation-for-_preValidatePurchase-in-Crowdsale-#1096
branch
from
ee549b7
to
1327bbb
Compare
|
Thanks for the heads up! Not sure how I did that? Should be all set now. |
nventuro
approved these changes
Jul 21, 2018
|
Maybe remains from a branch merge? Should be fine now, thanks for the quick PR! |
frangio
reviewed
Jul 22, 2018
contracts/crowdsale/Crowdsale.sol
Outdated
| @@ -110,7 +110,10 @@ contract Crowdsale { | |||
| // ----------------------------------------- | |||
|
|
|||
| /** | |||
| * @dev Validation of an incoming purchase. Use require statements to revert state when conditions are not met. Use super to concatenate validations. | |||
| * @dev Validation of an incoming purchase. Use require statements to revert state when conditions are not met. Use `super` in contracts that inherit from Crowdsale to extend their validations. | |||
| * @dev Example from CappedCrowdsale.sol's _preValidatePurchase method: | |||
There was a problem hiding this comment.
Nit: The second line shouldn't have a @dev tag. It somehow messes up Solidity's NatSpec parser. We changed this across OpenZeppelin in #995.
There was a problem hiding this comment.
Thanks! Didn't realize that. Fixed!
dougiebuckets
force-pushed
the
improve-documentation-for-_preValidatePurchase-in-Crowdsale-#1096
branch
from
e6e58c8
to
3058c37
Compare
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.
Fixes #1096
馃殌 Description
Improved documentation for _preValidatePurchase in Crowdsale. Hopefully this makes it more clear how one can use
superin contracts that inherit from Crowdsale in order to extend their validations.npm run lint:all:fix).