docs: Fix docstring for validate

Stranger6667 · Stranger6667 · commit 25fc533546a3 · 2024-12-15T23:44:11.000+01:00
Signed-off-by: Dmitry Dygalo &lt;dmitry@dygalo.dev&gt;
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())

Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ impl Validator {`
`193`	`193`	`pub fn new(schema: &Value) -> Result<Validator, ValidationError<'static>> {`
`194`	`194`	`Self::options().build(schema)`
`195`	`195`	`}`
`196`		- /// Run validation against `instance` and return an iterator over [`ValidationError`] in the error case.
	`196`	+ /// Validate `instance` against `schema` and return the first error if any.
`197`	`197`	`#[inline]`
`198`	`198`	`pub fn validate<'i>(&self, instance: &'i Value) -> Result<(), ValidationError<'i>> {`
`199`	`199`	`self.root.validate(instance, &LazyLocation::new())`