Skip to content

Commit

Permalink
Update doc/oper.xml
Browse files Browse the repository at this point in the history
Co-authored-by: James Mitchell <james-d-mitchell@users.noreply.github.com>
  • Loading branch information
DanielPointon and james-d-mitchell authored Feb 13, 2024
1 parent afc524f commit e1a7187
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/oper.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2295,7 +2295,7 @@ true
<Oper Name="IsOrderIdeal" Arg="D, subset" Label="for a digraph and list"/>
<Returns><K>true</K> or <K>false</K>.</Returns>
<Description>
This function returns <K>true</K> if the specified subset is "downwards" closed, i.e. contains every node less than the given nodes.
This function returns <K>true</K> if the specified subset is "downwards" closed, i.e. contains every vertex less than the given vertices.
The function can only be used on digraphs satisfying <Ref Prop="IsPartialOrderDigraph"/> and will throw an error if passed a digraph that is not a partial order digraph.

<Example><![CDATA[
Expand Down

0 comments on commit e1a7187

Please sign in to comment.