fix: Fix docstrings of ISequencerOracle

aave · Mar 15, 2022 · 4391fd4 · 4391fd4
1 parent f6b71f5
commit 4391fd4
Showing 1 changed file with 6 additions and 10 deletions.
diff --git a/contracts/interfaces/ISequencerOracle.sol b/contracts/interfaces/ISequencerOracle.sol
@@ -9,16 +9,12 @@ pragma solidity 0.8.10;
 interface ISequencerOracle {
   /**
    * @notice Returns the health status of the sequencer.
-   * @return roundId is the round ID from the aggregator for which the data was
-   * retrieved combined with a phase to ensure that round IDs get larger as
-   * time moves forward.   
-   * @return answer Is the answer for the latest round. The answer coming from the feed can only be 0 or 1.
-            0 - Sequencer is up
-            1 - Sequencer is down
-   * @return startedAt Is the timestamp when the round was started.
-   * @return updatedAt Is the block timestamp of the block in which the answer was updated on L1 
-   * @return answeredInRound is the round ID of the round in which the answer
-   * was computed.
+   * @return roundId The round ID from the aggregator for which the data was retrieved combined with a phase to ensure
+   * that round IDs get larger as time moves forward.
+   * @return answer The answer for the latest round: 0 if the sequencer is up, 1 if it is down.
+   * @return startedAt The timestamp when the round was started.
+   * @return updatedAt The timestamp of the block in which the answer was updated on L1.
+   * @return answeredInRound The round ID of the round in which the answer was computed.
    */
   function latestRoundData()
     external