Skip to content

Commit

Permalink
Correct docstrings in rose-transpose
Browse files Browse the repository at this point in the history
  • Loading branch information
samestep committed Apr 13, 2024
1 parent c8a05b2 commit 6bfb4c6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions crates/transpose/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ use std::mem::{replace, swap, take};
/// By convention, the first type in a function to be transposed must be the nonlinear `F64`.
const REAL: id::Ty = id::ty(0);

/// By convention, the first type in a function to be transposed must be the linear `F64`.
/// By convention, the second type in a function to be transposed must be the linear `F64`.
const DUAL: id::Ty = id::ty(1);

/// Return true iff `t` is the type ID of a linear type in a function to be transposed.
/// Return true iff `t` is the type ID of a primitive type in a function to be transposed.
///
/// In this module, "primitive" specifically means a linear or nonlinear `F64` type, and
/// specifically excludes other types that might be considered primitive, such as `Unit` or `Bool`.
Expand All @@ -25,7 +25,7 @@ const RE: id::Member = id::member(1);
/// The source of a primitive variable or a component of a dual number variable.
///
/// The value `None` means that this is the original source, whereas `Some` means that it is an
/// alias of a the given primitive variable or a component of the given dual number variable.
/// alias of the given primitive variable or a component of the given dual number variable.
#[derive(Clone, Copy)]
struct Src(Option<id::Var>);

Expand Down

0 comments on commit 6bfb4c6

Please sign in to comment.