Skip to content

style: fix doc indentation #742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2025
Merged

style: fix doc indentation #742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
//! * [`crate::metadata::MigrationMetadata`]
//! * [`crate::metadata::PopulationMetadata`]
//!
//! To see these derive macros in action, take a look
//! [`here`](metadata).
//! To see these derive macros in action, take a look
//! [`here`](metadata).
//!
//! To add features to your `Cargo.toml` file:
//!
Expand Down
12 changes: 6 additions & 6 deletions src/table_collection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1540,9 +1540,9 @@ impl TableCollection {
/// # Parameters
///
/// * `f`: a function. The function is passed the current table
/// collection and each [`crate::node_table::NodeTableRow`].
/// If `f` returns `true`, the index of that row is included
/// in the return value.
/// collection and each [`crate::node_table::NodeTableRow`].
/// If `f` returns `true`, the index of that row is included
/// in the return value.
///
/// # Examples
///
Expand Down Expand Up @@ -1585,10 +1585,10 @@ impl TableCollection {
/// # Return value
/// - `Ok(None)`: when truncation leads to empty edge table.
/// - `Ok(Some(TableCollection))`: when trunction is successfully performed
/// and results in non-empty edge table. The table collection is sorted.
/// and results in non-empty edge table. The table collection is sorted.
/// - `Error(TskitError)`: Any errors from the C API propagate. An
/// [TskitError::RangeError] will occur when `intervals` are not
/// sorted.
/// [TskitError::RangeError] will occur when `intervals` are not
/// sorted.
///
/// # Notes
///
Expand Down
12 changes: 6 additions & 6 deletions src/trees/treeseq.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,10 +366,10 @@ impl TreeSequence {
/// # Return value
/// - `Ok(None)`: when truncation leads to empty edge table.
/// - `Ok(Some(TableCollection))`: when trunction is successfully performed
/// and results in non-empty edge table. The tables are sorted.
/// and results in non-empty edge table. The tables are sorted.
/// - `Error(TskitError)`: Any errors from the C API propagate. An
/// [TskitError::RangeError] will occur when `intervals` are not
/// sorted.
/// [TskitError::RangeError] will occur when `intervals` are not
/// sorted.
///
/// # Notes
///
Expand Down Expand Up @@ -604,9 +604,9 @@ impl TreeSequence {
/// # Parameters
///
/// * `f`: a function. The function is passed the current table
/// collection and each [`crate::node_table::NodeTableRow`].
/// If `f` returns `true`, the index of that row is included
/// in the return value.
/// collection and each [`crate::node_table::NodeTableRow`].
/// If `f` returns `true`, the index of that row is included
/// in the return value.
///
/// # Examples
///
Expand Down
Loading