updated docstring too

MaimonLab · Aug 15, 2024 · e4abaf4 · e4abaf4
1 parent 6f3f1eb
commit e4abaf4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/siffreader.rs b/src/siffreader.rs
@@ -196,7 +196,15 @@ impl SiffReader{
     /// Size of the FLIM arrival time histogram
     /// in bins.
     /// 
+    /// ## Returns
+    /// 
+    /// Number of actual bins (irrespective of what the bin
+    /// size corresponds to in real time units)
+    /// 
+    /// ## Errors
     /// 
+    /// * `CorrosiffError::DimensionsError(DimensionsError)` - If the histogram size
+    /// is unknown or was unable to be parsed (or if the file is not a `.siff`)
     pub fn num_flim_bins(&self) -> Result<u32, CorrosiffError> {
         self.file_format.num_flim_tau_bins()
         .ok_or(CorrosiffError::DimensionsError(