Skip to content

Commit 94692ac

Browse files
authored
Crowdsale docs improvements. (#1446)
* Added a small Crowdsale fallback gas warning. * Fixed a couple typos.
1 parent 384dff9 commit 94692ac

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

contracts/crowdsale/Crowdsale.sol

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ contract Crowdsale {
7373

7474
/**
7575
* @dev fallback function ***DO NOT OVERRIDE***
76+
* Note that other contracts will transfer fund with a base gas stipend
77+
* of 2300, which is not enough to call buyTokens. Consider calling
78+
* buyTokens directly when purchasing tokens from a contract.
7679
*/
7780
function () external payable {
7881
buyTokens(msg.sender);
@@ -100,15 +103,15 @@ contract Crowdsale {
100103
}
101104

102105
/**
103-
* @return the mount of wei raised.
106+
* @return the amount of wei raised.
104107
*/
105108
function weiRaised() public view returns (uint256) {
106109
return _weiRaised;
107110
}
108111

109112
/**
110113
* @dev low level token purchase ***DO NOT OVERRIDE***
111-
* @param beneficiary Address performing the token purchase
114+
* @param beneficiary Recipient of the token purchase
112115
*/
113116
function buyTokens(address beneficiary) public payable {
114117

@@ -188,7 +191,7 @@ contract Crowdsale {
188191
}
189192

190193
/**
191-
* @dev Executed when a purchase has been validated and is ready to be executed. Not necessarily emits/sends tokens.
194+
* @dev Executed when a purchase has been validated and is ready to be executed. Doesn't necessarily emit/send tokens.
192195
* @param beneficiary Address receiving the tokens
193196
* @param tokenAmount Number of tokens to be purchased
194197
*/

0 commit comments

Comments
 (0)