Add docs to EvaledExpr::fmt

Gawdl3y · Mar 19, 2024 · 1f20aa9 · 1f20aa9
1 parent ae6e42b
commit 1f20aa9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/expr.rs b/src/expr.rs
@@ -223,6 +223,11 @@ impl Describe for EvaledExpr<'_> {
 }
 
 impl std::fmt::Display for EvaledExpr<'_> {
+	/// Formats the value using the given formatter. [Read more][core::fmt::Debug::fmt()]
+	///
+	/// The output of this implementation is equivalent to [`EvaledExpr::describe(None)`].
+	///
+	/// [`EvaledExpr::describe(None)`]: ./enum.EvaledExpr.html#method.describe
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		write!(f, "{}", self.describe(None))
 	}