Skip to content

Commit 40d2240

Browse files
committed
docs: natspec fixes
1 parent ec9e89c commit 40d2240

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

contracts/src/arbitration/KlerosCore.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1366,7 +1366,7 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
13661366
function _extraDataToCourtIDMinJurorsDisputeKit(
13671367
bytes memory _extraData
13681368
) internal view returns (uint96 courtID, uint256 minJurors, uint256 disputeKitID) {
1369-
// Note that if the extradata doesn't contain 32 bytes for the dispute kit ID it'll return the default 0 index.
1369+
// Note that if the _extraData doesn't contain 32 bytes, default values are used.
13701370
if (_extraData.length >= 64) {
13711371
assembly {
13721372
// solium-disable-line security/no-inline-assembly
@@ -1381,7 +1381,7 @@ contract KlerosCore is IArbitratorV2, Initializable, UUPSProxiable {
13811381
minJurors = DEFAULT_NB_OF_JURORS;
13821382
}
13831383
if (disputeKitID == NULL_DISPUTE_KIT || disputeKitID >= disputeKits.length) {
1384-
disputeKitID = DISPUTE_KIT_CLASSIC; // 0 index is not used.
1384+
disputeKitID = DISPUTE_KIT_CLASSIC;
13851385
}
13861386
} else {
13871387
courtID = GENERAL_COURT;

contracts/src/arbitration/SortitionModule.sol

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ contract SortitionModule is ISortitionModule, Initializable, UUPSProxiable {
5353
mapping(TreeKey key => SortitionTrees.Tree) sortitionSumTrees; // The mapping of sortition trees by keys.
5454
mapping(address account => Juror) public jurors; // The jurors.
5555
mapping(uint256 => DelayedStake) public delayedStakes; // Stores the stakes that were changed during Drawing phase, to update them when the phase is switched to Staking.
56-
uint256 public maxStakePerJuror; // The maximum amount of PNK a juror can stake in a court.
57-
uint256 public maxTotalStaked; // The maximum amount of PNK that can be staked in all courts.
58-
uint256 public totalStaked; // The amount that is currently staked in all courts.
56+
uint256 public maxStakePerJuror; // The maximum amount of PNK that a juror can stake across the courts.
57+
uint256 public maxTotalStaked; // The maximum amount of PNK that all the jurors can stake across the courts.
58+
uint256 public totalStaked; // The amount of PNK that is currently staked across the courts.
5959

6060
// ************************************* //
6161
// * Events * //
@@ -105,8 +105,8 @@ contract SortitionModule is ISortitionModule, Initializable, UUPSProxiable {
105105
/// @param _minStakingTime Minimal time to stake
106106
/// @param _maxDrawingTime Time after which the drawing phase can be switched
107107
/// @param _rng The random number generator.
108-
/// @param _maxStakePerJuror The maximum amount of PNK a juror can stake in a court.
109-
/// @param _maxTotalStaked The maximum amount of PNK that can be staked in all courts.
108+
/// @param _maxStakePerJuror The maximum amount of PNK a juror can stake across the courts.
109+
/// @param _maxTotalStaked The maximum amount of PNK that all the jurors can stake across the courts.
110110
function initialize(
111111
address _owner,
112112
KlerosCore _core,

0 commit comments

Comments
 (0)