Skip to content

Commit

Permalink
Apply suggestions: Doc comments
Browse files Browse the repository at this point in the history
Co-authored-by: Jan Winkelmann <[email protected]>
  • Loading branch information
jschneider-bensch and keks authored Feb 7, 2024
1 parent 0f207ba commit f3135a3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions mpc-spec/src/circuit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,18 +72,18 @@ pub type WireIndex = usize;
#[derive(Debug, Clone)]
pub enum WiredGate {
/// An input wire, with its value coming directly from one of the parties.
/// Its [WireIndex] must refer to its own gate index.
/// Its [`WireIndex`] must refer to its own gate index.
Input(WireIndex),
/// A logical XOR gate attached to the two specified input wires. The
/// [WireIndex] of each input wire must refer to a lower index than the
/// [`WireIndex`] of each input wire must refer to a lower index than the
/// gate's own index.
Xor(WireIndex, WireIndex),
/// A logical AND gate attached to the two specified input wires. The
/// [WireIndex] of each input wire must refer to a lower index than the
/// [`WireIndex`] of each input wire must refer to a lower index than the
/// gate's own index.
And(WireIndex, WireIndex),
/// A logical NOT gate attached to the specified input wire. The
/// [WireIndex] of the input wire must refer to a lower index than the
/// [`WireIndex`] of the input wire must refer to a lower index than the
/// gate's own index.
Not(WireIndex),
}
Expand All @@ -95,7 +95,7 @@ pub type InputWidth = usize;
#[derive(Debug, Clone)]
pub struct Circuit {
/// The bit-width of the inputs expected by the different parties,
/// [InputWidth] at index `i` representing the number of input bits for
/// [`InputWidth`] at index `i` representing the number of input bits for
/// party `i`.
pub input_widths: Vec<InputWidth>,
/// The circuit's gates.
Expand Down

0 comments on commit f3135a3

Please sign in to comment.