Skip to content

Commit

Permalink
Improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cpmech committed Aug 21, 2024
1 parent f373601 commit c6f62e6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/plot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,9 @@ impl Plot {
///
/// # Note
///
/// The input must be the same file which was saved by `plot.save()`. Be sure the
/// plot has been saved before calling `plot.show()`. This method only works in
/// Jupyter Notebook.
/// 1. This method only works in a Jupyter Notebook
/// 2. The input must be the same saved by `plot.save(...)`. Thus, make sure
/// that the plot has been saved before calling `plot.show_in_evcxr()`.
pub fn show_in_evcxr<S>(&self, figure_path: &S) -> Result<(), StrError>
where
S: AsRef<OsStr> + ?Sized,
Expand Down

0 comments on commit c6f62e6

Please sign in to comment.