docs: Fix docstring for validate

Signed-off-by: Dmitry Dygalo <[email protected]>
Stranger6667 · Dec 15, 2024 · f464b8d · f464b8d
1 parent 025084a
commit f464b8d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Documentation
+
+- Fix documentation for `validate`
+
 ## [0.26.1] - 2024-10-29
 
 ### Fixed

diff --git a/crates/jsonschema/src/validator.rs b/crates/jsonschema/src/validator.rs
@@ -193,7 +193,7 @@ impl Validator {
     pub fn new(schema: &Value) -> Result<Validator, ValidationError<'static>> {
         Self::options().build(schema)
     }
-    /// Run validation against `instance` and return an iterator over [`ValidationError`] in the error case.
+    /// Validate `instance` against `schema` and return the first error if any.
     #[inline]
     pub fn validate<'i>(&self, instance: &'i Value) -> Result<(), ValidationError<'i>> {
         self.root.validate(instance, &LazyLocation::new())