[P1-N04] Fix typos (#1206)

Signed-off-by: Matt Rice <matthewcrice32@gmail.com>

Author: mrice32

core/contracts/common/implementation/MultiRole.sol

@@ -186,8 +186,8 @@ abstract contract MultiRole {
     }
 
     /**
-     * @notice Internal method to initialize a exclusive role, `roleId`, which will be managed by `managingRoleId`.
-     * `initialMembers` will be immediately added to the role.
+     * @notice Internal method to initialize an exclusive role, `roleId`, which will be managed by `managingRoleId`.
+     * `initialMember` will be immediately added to the role.
      * @dev Should be called by derived contracts, usually at construction time. Will revert if the role is already
      * initialized.
      */

core/contracts/oracle/implementation/IdentifierWhitelist.sol

@@ -27,8 +27,8 @@ contract IdentifierWhitelist is IdentifierWhitelistInterface, Ownable {
 
     /**
      * @notice Adds the provided identifier as a supported identifier.
-     * @dev Price requests using this identifier will be succeed after this call.
-     * @param identifier uniquely identifies added the identifier. Eg: BTC/UCD.
+     * @dev Price requests using this identifier will succeed after this call.
+     * @param identifier unique UTF-8 representation for the feed being added. Eg: BTC/USD.
      */
     // TODO(#969) Remove once prettier-plugin-solidity can handle the "override" keyword
     // prettier-ignore
@@ -42,7 +42,7 @@ contract IdentifierWhitelist is IdentifierWhitelistInterface, Ownable {
     /**
      * @notice Removes the identifier from the whitelist.
      * @dev Price requests using this identifier will no longer succeed after this call.
-     * @param identifier uniquely identifies added the identifier. Eg: BTC/UCD.
+     * @param identifier unique UTF-8 representation for the feed being removed. Eg: BTC/USD.
      */
     // TODO(#969) Remove once prettier-plugin-solidity can handle the "override" keyword
     // prettier-ignore
@@ -59,7 +59,7 @@ contract IdentifierWhitelist is IdentifierWhitelistInterface, Ownable {
 
     /**
      * @notice Checks whether an identifier is on the whitelist.
-     * @param identifier uniquely identifies added the identifier. Eg: BTC/UCD.
+     * @param identifier unique UTF-8 representation for the feed being queried. Eg: BTC/USD.
      * @return bool if the identifier is supported (or not).
      */
     // TODO(#969) Remove once prettier-plugin-solidity can handle the "override" keyword

core/contracts/oracle/implementation/Registry.sol

@@ -116,7 +116,7 @@ contract Registry is RegistryInterface, MultiRole {
     }
 
     /**
-     * @notice Removes a party member to the calling contract.
+     * @notice Removes a party member from the calling contract.
      * @dev msg.sender will be used to determine the contract that this party is removed from.
      * @param partyAddress address to be removed from the calling contract.
      */

core/contracts/oracle/implementation/ResultComputation.sol

@@ -52,7 +52,7 @@ library ResultComputation {
      * @notice Returns whether the result is resolved, and if so, what value it resolved to.
      * @dev `price` should be ignored if `isResolved` is false.
      * @param data contains information against which the `minVoteThreshold` is applied.
-     * @param minVoteThreshold min number of tokens that must have been voted for the result to be valid. Can be
+     * @param minVoteThreshold min number of tokens that must have voted for the result to be valid. Can be
      * used to enforce a minimum voter participation rate, regardless of how the votes are distributed.
      * @return isResolved indicates if the price has been resolved correctly.
      * @return price the price that the dvm resolved to.
@@ -92,7 +92,7 @@ library ResultComputation {
      * @notice Gets the total number of tokens whose votes are considered correct.
      * @dev Should only be called after a vote is resolved, i.e., via `getResolvedPrice`.
      * @param data contains all votes against which the correctly voted tokens are counted.
-     * @return FixedPoint.Unsigned which indicates the correctly frequency of the correctly voted tokens.
+     * @return FixedPoint.Unsigned which indicates the frequency of the correctly voted tokens.
      */
     function getTotalCorrectlyVotedTokens(Data storage data) internal view returns (FixedPoint.Unsigned memory) {
         return data.voteFrequency[data.currentMode];

core/contracts/oracle/implementation/Voting.sol

@@ -212,7 +212,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
      * @notice Enqueues a request (if a request isn't already present) for the given `identifier`, `time` pair.
      * @dev Time must be in the past and the identifier must be supported.
      * @param identifier uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
-     * @param time unix timestamp of for the price request.
+     * @param time unix timestamp for the price request.
      */
     // TODO(#969) Remove once prettier-plugin-solidity can handle the "override" keyword
     // prettier-ignore
@@ -276,8 +276,8 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
     /**
      * @notice Gets the status of a list of price requests, identified by their identifier and time.
      * @dev If the status for a particular request is NotRequested, the lastVotingRound will always be 0.
-     * @param requests array of time PendingRequest which includes a identifier and timestamp for each request.
-     * @return requestStates A lis, in the same order as the input list, giving the status of each of the specified price requests.
+     * @param requests array of type PendingRequest which includes an identifier and timestamp for each request.
+     * @return requestStates A list, in the same order as the input list, giving the status of each of the specified price requests.
      */
     function getPriceRequestStatuses(PendingRequest[] memory requests)
         public
@@ -311,7 +311,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
      * @dev `identifier`, `time` must correspond to a price request that's currently in the commit phase.
      * Commits can be changed.
      * @param identifier uniquely identifies the committed vote. EG BTC/USD price pair.
-     * @param time unix timestamp of the price is being voted on.
+     * @param time unix timestamp of the price being voted on.
      * @param hash keccak256 hash of the price you want to vote for and a `int salt`.
      */
     // TODO(#969) Remove once prettier-plugin-solidity can handle the "override" keyword
@@ -343,7 +343,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
      * @dev The revealed `price` and `salt` must match the latest `hash` that `commitVote()` was called with.
      * Only the committer can reveal their vote.
      * @param identifier voted on in the commit phase. EG BTC/USD price pair.
-     * @param time specifies the unix timestamp of the price is being voted on.
+     * @param time specifies the unix timestamp of the price being voted on.
      * @param price voted on during the commit phase.
      * @param salt value used to hide the commitment price during the commit phase.
      */
@@ -393,7 +393,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
     /**
      * @notice commits a vote and stores an encrypted version which can be later decrypted
      * to recover the voter's price & salt.
-     * @dev The encryption mechanism uses encrypt from a signature from a users price key. See `EncryptedSender.sol`
+     * @dev The encryption mechanism uses encrypt from a signature from a users price key. See `EncryptedStore.sol`
      * @param identifier unique price pair identifier. Eg: BTC/USD price pair.
      * @param time unix timestamp of for the price request.
      * @param hash keccak256 hash of the price you want to vote for and a `int salt`.
@@ -602,7 +602,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
     /**
      * @notice Resets the inflation rate. Note: this change only applies to rounds that have not yet begun.
      * @dev This method is public because calldata structs are not currently supported by solidity.
-     * @param newInflationRate sets the next rounds inflation rate.
+     * @param newInflationRate sets the next round's inflation rate.
      */
     function setInflationRate(FixedPoint.Unsigned memory newInflationRate) public onlyOwner {
         inflationRate = newInflationRate;
@@ -611,7 +611,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
     /**
      * @notice Resets the Gat percentage. Note: this change only applies to rounds that have not yet begun.
      * @dev This method is public because calldata structs are not currently supported by solidity.
-     * @param newGatPercentage sets the next rounds Gat percentage.
+     * @param newGatPercentage sets the next round's Gat percentage.
      */
     function setGatPercentage(FixedPoint.Unsigned memory newGatPercentage) public onlyOwner {
         require(newGatPercentage.isLessThan(1), "GAT percentage must be < 100%");
@@ -708,7 +708,7 @@ contract Voting is Testable, Ownable, OracleInterface, VotingInterface, Encrypte
             return FixedPoint.Unsigned(UINT_MAX);
         }
 
-        // Grab the snaphotted supply from the voting token. It's already scaled by 10**18, so we can directly
+        // Grab the snapshotted supply from the voting token. It's already scaled by 10**18, so we can directly
         // initialize the Unsigned value with the returned uint.
         FixedPoint.Unsigned memory snapshottedSupply = FixedPoint.Unsigned(votingToken.totalSupplyAt(snapshotId));
 

core/contracts/oracle/interfaces/IdentifierWhitelistInterface.sol

@@ -9,7 +9,7 @@ pragma experimental ABIEncoderV2;
 interface IdentifierWhitelistInterface {
     /**
      * @notice Adds the provided identifier as a supported identifier.
-     * @dev Price requests using this identifier will be succeed after this call.
+     * @dev Price requests using this identifier will succeed after this call.
      * @param identifier bytes32 encoding of the string identifier. Eg: BTC/USD.
      */
     function addSupportedIdentifier(bytes32 identifier) external;

core/contracts/oracle/interfaces/OracleInterface.sol

@@ -10,15 +10,15 @@ interface OracleInterface {
      * @notice Enqueues a request (if a request isn't already present) for the given `identifier`, `time` pair.
      * @dev Time must be in the past and the identifier must be supported.
      * @param identifier uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
-     * @param time unix timestamp of for the price request.
+     * @param time unix timestamp for the price request.
      */
     function requestPrice(bytes32 identifier, uint time) external;
 
     /**
      * @notice Whether the price for `identifier` and `time` is available.
      * @dev Time must be in the past and the identifier must be supported.
      * @param identifier uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
-     * @param time unix timestamp of for the price request.
+     * @param time unix timestamp for the price request.
      * @return bool if the DVM has resolved to a price for the given identifier and timestamp.
      */
     function hasPrice(bytes32 identifier, uint time) external view returns (bool);
@@ -27,8 +27,8 @@ interface OracleInterface {
      * @notice Gets the price for `identifier` and `time` if it has already been requested and resolved.
      * @dev If the price is not available, the method reverts.
      * @param identifier uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
-     * @param time unix timestamp of for the price request.
-     * @return int representing the resolved price for the given identifer and timestamp.
+     * @param time unix timestamp for the price request.
+     * @return int representing the resolved price for the given identifier and timestamp.
      */
     function getPrice(bytes32 identifier, uint time) external view returns (int);
 }

core/contracts/oracle/interfaces/VotingInterface.sol

@@ -43,8 +43,8 @@ abstract contract VotingInterface {
      * @dev `identifier`, `time` must correspond to a price request that's currently in the commit phase.
      * Commits can be changed.
      * @param identifier uniquely identifies the committed vote. EG BTC/USD price pair.
-     * @param time unix timestamp of the price is being voted on.
-     * @param hash keccak256 hash of the price you want to vote for and a `int salt`.
+     * @param time unix timestamp of the price being voted on.
+     * @param hash keccak256 hash of the price you want to vote for and your random salt.
      */
     function commitVote(bytes32 identifier, uint time, bytes32 hash) external virtual;
 
@@ -53,7 +53,7 @@ abstract contract VotingInterface {
      * @dev Using `encryptedVote` is optional. If included then commitment is stored on chain.
      * Look at `project-root/common/Constants.js` for the tested maximum number of
      * commitments that can fit in one transaction.
-     * @param commits struct to encapsulate an `identifier`, `time`, `hash` and optional `encryptedVote`.
+     * @param commits array of structs that encapsulate an `identifier`, `time`, `hash` and optional `encryptedVote`.
      */
     function batchCommit(Commitment[] calldata commits) external virtual;
 
@@ -103,7 +103,7 @@ abstract contract VotingInterface {
      * @param voterAddress voter for which rewards will be retrieved. Does not have to be the caller.
      * @param roundId the round from which voting rewards will be retrieved from.
      * @param toRetrieve array of PendingRequests which rewards are retrieved from.
-     * @return totalRewardToIssue total amount of rewards returned to the voter.
+     * @return total amount of rewards returned to the voter.
      */
     function retrieveRewards(address voterAddress, uint roundId, PendingRequest[] memory toRetrieve)
         public