Skip to content

Commit

Permalink
Fixed description of link node with soft constraints
Browse files Browse the repository at this point in the history
  • Loading branch information
s-simoncelli committed Oct 1, 2024
1 parent 03565df commit 9fb98cf
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions pywr-schema/src/nodes/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,11 @@ pub struct SoftConstraint {
/// ```
///
/// # Soft constraints
/// This node allows setting optional maximum and minimum soft constraints which means the node's `min_flow`
/// and `max_flow` properties may be breached, as specified by the user in the `soft_max` and `soft_min`
/// properties. When the two attributes are provided, the internal representation of the link will
/// look like this:
/// This node allows setting optional maximum and minimum soft constraints via the `soft_min.flow`
/// and `soft_max.flow` properties. These may be breached depending on the costs set on the
/// optional nodes. However, the combined flow through the internal nodes will always be bound
/// between the `min_flow` and `max_flow` attributes. When the two attributes are provided, the
/// internal representation of the link will look like this:
///
/// ```svgbob
/// <Link>.soft_max
Expand Down Expand Up @@ -373,7 +374,7 @@ impl LinkNode {
None,
)?;
}
_ => {}
(None, None) => {}
};
Ok(())
}
Expand Down

0 comments on commit 9fb98cf

Please sign in to comment.