Skip to content

Commit

Permalink
Fix documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris00 committed Jan 2, 2024
1 parent 481b841 commit aa1d115
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/cvode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -311,14 +311,14 @@ impl Drop for CVodeMem {
pub enum CVStatus {
Ok,
/// Succeeded by reaching the stopping point specified through
/// [`CVode::set_tstop`].
/// [`CVodeConf::set_tstop`].
Tstop(f64),
Root(f64, Vec<bool>),
IllInput,
/// The initial time `t0` and the output time `t` are too close to
/// each other and the user did not specify an initial step size.
TooClose,
/// The solver took [`CVode::mxsteps`] internal steps but could
/// The solver took [`CVodeConf::mxsteps`] internal steps but could
/// not reach the final time.
TooMuchWork,
/// The solver could not satisfy the accuracy demanded by the user
Expand Down
10 changes: 6 additions & 4 deletions src/vector/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ pub unsafe trait Vector: Clone {
type NVectorMut<'a>;

/// Return a wrapper of a `N_Vector` that references `self`. If
/// `self` already possesses a [`Context`], this *must* check that
/// both contexts are the same and return `None` otherwise.
/// `self` already possesses a [`Context`][crate::Context], this
/// *must* check that both contexts are the same and return `None`
/// otherwise.
///
/// # Safety
/// The return value must not outlive `ctx` (and neither `self` but
Expand All @@ -42,8 +43,9 @@ pub unsafe trait Vector: Clone {
v: &Self, ctx: SUNContext) -> Option<Self::NVectorRef<'_>>;

/// Return a wrapper of a `N_Vector` that can mutate `self`. If
/// `self` already possesses a [`Context`], this *must* check that
/// both contexts are the same and return `None` otherwise.
/// `self` already possesses a [`Context`][crate::Context], this
/// *must* check that both contexts are the same and return `None`
/// otherwise.
///
/// # Safety
/// The return value must not outlive `ctx` (and neither `self` but
Expand Down

0 comments on commit aa1d115

Please sign in to comment.