Skip to content

Commit 1722f28

Browse files
committed
Update doc comments for recent changes.
1 parent 2f8ac11 commit 1722f28

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

crates/wac-graph/src/graph.rs

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -859,18 +859,22 @@ impl CompositionGraph {
859859
true
860860
}
861861

862-
/// Connects an argument node to an instantiation node by adding an _instantiation argument_
863-
/// edge between them.
862+
/// Sets an argument of an instantiation node to the provided argument
863+
/// node.
864864
///
865-
/// The provided node must be an instantiation node.
865+
/// This method adds an _instantiation argument_ edge from the argument
866+
/// node to the instantiation node.
866867
///
867-
/// The argument node must be type-compatible with the argument of the instantiation node.
868+
/// The provided instantiation node must be an instantiation.
868869
///
869-
/// The argument name must be a valid import on the instantiation node and not already have
870-
/// an incoming edge from a different argument node.
870+
/// The argument name must be a valid import on the instantiation node
871+
/// and not already have an incoming edge from a different argument node.
871872
///
872-
/// If an edge already exists between the argument and the instantiation node, this method
873-
/// returns `Ok(_)`.
873+
/// The argument node must be type-compatible with the argument of the
874+
/// instantiation node.
875+
///
876+
/// If an edge already exists between the argument and the instantiation
877+
/// node, this method returns `Ok(_)`.
874878
pub fn set_instantiation_argument(
875879
&mut self,
876880
instantiation: NodeId,
@@ -998,15 +1002,16 @@ impl CompositionGraph {
9981002
result
9991003
}
10001004

1001-
/// Disconnects an argument node from an instantiation node by removing the
1002-
/// *instantiation argument edge* between them.
1005+
/// Unsets an argument of an instantiation node that was previously
1006+
/// set to the provided argument node.
10031007
///
1004-
/// The provided node must be an instantiation.
1008+
/// This method removes an _instantiation argument_ edge from the
1009+
/// argument node to the instantiation node if the nodes are connected;
1010+
/// if they are not connected, this method is a no-op.
10051011
///
1006-
/// The argument name must be a valid import on the target.
1012+
/// The provided instantiation node must be an instantiation.
10071013
///
1008-
/// If the argument is not connected to the instantiation node, then this
1009-
/// function will be a no-op.
1014+
/// The argument name must be a valid import on the instantiation node.
10101015
pub fn unset_instantiation_argument(
10111016
&mut self,
10121017
instantiation: NodeId,

0 commit comments

Comments
 (0)