Skip to content

Commit

Permalink
work on doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
dfsp-spirit committed Mar 3, 2021
1 parent c2ba03a commit 11f79a8
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/fs_surface.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! Functions for managing FreeSurfer brain surface meshes in binary 'surf' files.
//!
//! These files store a triangular mesh, where each vertex is defined by its x,y,z coords and
//! Surf files store a triangular mesh, where each vertex is defined by its x,y,z coords and
//! each face is defined by 3 vertices, stored as 3 row-indices into the vertices matrix.
//! These vertex indices are zero-based.

Expand Down Expand Up @@ -182,7 +182,12 @@ impl BrainMesh {

/// Read an FsSurface instance from a file.
///
/// See [`crate::read_curv`] to read per-vertex data for the mesh.
/// Surf files store a triangular mesh, where each vertex is defined by its x,y,z coords and
/// each face is defined by 3 vertices, stored as 3 row-indices into the vertices matrix.
/// These vertex indices are zero-based. The mesh typically represents a single brain hemisphere.
///
/// See [`crate::read_curv`] to read per-vertex data for the mesh and [`crate::read_annot`] to
/// read atlas-based parcellations.
///
/// # Examples
///
Expand Down

0 comments on commit 11f79a8

Please sign in to comment.