docs: extra comment for passPhase()

jaybuidl · jaybuidl · commit b79179b12ecb · 2022-05-26T13:54:09.000+01:00
diff --git a/contracts/src/arbitration/KlerosCore.sol b/contracts/src/arbitration/KlerosCore.sol
@@ -514,6 +514,7 @@ contract KlerosCore is IArbitrator {
     }
 
     /** @dev Switches the phases between Staking and Freezing, also signal the switch to the dispute kits.
+     * Note: Invariant: do not emit a `NewPhase` event if the phase is unchanged.
      */
     function passPhase() external {
         if (phase == Phase.staking) {
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol b/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol
@@ -185,6 +185,7 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {
     }
 
     /** @dev Passes the phase.
+     * Note: Invariant: do not emit a `NewPhaseDisputeKit` event if the phase is unchanged.
      */
     function passPhase() external override {
         if (core.phase() == KlerosCore.Phase.staking || core.isFreezingPhaseFinished()) {
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol b/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol
@@ -203,6 +203,7 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {
     }
 
     /** @dev Passes the phase.
+     * Note: Invariant: do not emit a `NewPhaseDisputeKit` event if the phase is unchanged.
      */
     function passPhase() external override {
         if (core.phase() == KlerosCore.Phase.staking || core.isFreezingPhaseFinished()) {

Original file line number	Diff line number	Diff line change
`@@ -514,6 +514,7 @@ contract KlerosCore is IArbitrator {`
`514`	`514`	`}`
`515`	`515`
`516`	`516`	`/** @dev Switches the phases between Staking and Freezing, also signal the switch to the dispute kits.`
	`517`	+ * Note: Invariant: do not emit a `NewPhase` event if the phase is unchanged.
`517`	`518`	`*/`
`518`	`519`	`function passPhase() external {`
`519`	`520`	`if (phase == Phase.staking) {`
Original file line number	Diff line number	Diff line change
`@@ -185,6 +185,7 @@ contract DisputeKitClassic is BaseDisputeKit, IEvidence {`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`/** @dev Passes the phase.`
	`188`	+ * Note: Invariant: do not emit a `NewPhaseDisputeKit` event if the phase is unchanged.
`188`	`189`	`*/`
`189`	`190`	`function passPhase() external override {`
`190`	`191`	`if (core.phase() == KlerosCore.Phase.staking \|\| core.isFreezingPhaseFinished()) {`
Original file line number	Diff line number	Diff line change
`@@ -203,6 +203,7 @@ contract DisputeKitSybilResistant is BaseDisputeKit, IEvidence {`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`/** @dev Passes the phase.`
	`206`	+ * Note: Invariant: do not emit a `NewPhaseDisputeKit` event if the phase is unchanged.
`206`	`207`	`*/`
`207`	`208`	`function passPhase() external override {`
`208`	`209`	`if (core.phase() == KlerosCore.Phase.staking \|\| core.isFreezingPhaseFinished()) {`