TBTCSYstem doc updates
Use cleaner language
Fix typos
@@ -17,9 +17,9 @@ import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
import "openzeppelin-solidity/contracts/math/SafeMath.sol";
/// @title TBTC System.
-/// @notice This contract acts as a central point for ACL,
-/// value governance, and price oracle.
-/// @dev Governable values only affect new deposit creation.
+/// @notice This contract acts as a central point for access control,
+/// value governance, and price feed.
+/// @dev Governable values should only affect new deposit creation.
contract TBTCSystem is Ownable, ITBTCSystem, DepositLog {
using SafeMath for uint256;
@@ -55,12 +55,12 @@ contract TBTCSystem is Ownable, ITBTCSystem, DepositLog {
}
/// @notice Initialize contracts
- /// @dev Only the Deposit factory can call this.
+ /// @dev Only the Deposit factory should call this.
/// @param _keepVendor ECDSA keep vendor address.
- /// @param _depositFactory Deposit Fctpry address. More info in DepositFactory.sol.
- /// @param _masterDepositAddress Master Deposit address. more info in Deposit.sol.
+ /// @param _depositFactory Deposit Factory address. More info in DepositFactory.sol.
+ /// @param _masterDepositAddress Master Deposit address. More info in Deposit.sol.
/// @param _tbtcToken TBTCToken address. More info in TBTCToken.sol.
- /// @param _tbtcDepositToken TBTCDepositToken (TDT) address. more info in TBTCDepositToken.sol.
+ /// @param _tbtcDepositToken TBTCDepositToken (TDT) address. More info in TBTCDepositToken.sol.
/// @param _feeRebateToken FeeRebateToken (FRT) address. More info in FeeRebateToken.sol.
/// @param _vendingMachine Vending Machine address. More info in VendingMachine.sol
/// @param _keepThreshold Signing group honesty threshold.
