Skip to content

Commit e4163cd

Browse files
lint docs
1 parent 350871a commit e4163cd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/interface/unstable/IOrderBookV6.sol

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,15 @@ import {Float} from "rain.math.float/lib/LibDecimalFloat.sol";
3535

3636
/// Config for a list of orders to take sequentially as part of a `takeOrders`
3737
/// call.
38-
/// @param minimumInput Minimum input from the perspective of the order taker.
39-
/// @param maximumInput Maximum input from the perspective of the order taker.
38+
/// @param minimumInput Minimum input/output from the perspective of the order
39+
/// taker.
40+
/// @param maximumInput Maximum input/output from the perspective of the order
41+
/// taker.
4042
/// @param maximumIORatio Maximum IO ratio as calculated by the order being
4143
/// taken. The input is from the perspective of the order so higher ratio means
4244
/// worse deal for the order taker.
45+
/// @param IOIsInput If true, the minimum and maximum amounts are the input from
46+
/// the perspective of the order taker. If false, they are the output.
4347
/// @param orders Ordered list of orders that will be taken until the limit is
4448
/// hit. Takers are expected to prioritise orders that appear to be offering
4549
/// better deals i.e. lower IO ratios. This prioritisation and sorting MUST

0 commit comments

Comments
 (0)