From cb62db560905d73fca82ed2a61d32fd0d850dd03 Mon Sep 17 00:00:00 2001 From: zhb Date: Wed, 15 Mar 2023 12:04:52 +0800 Subject: [PATCH] fix documentation error. --- .gitignore | 2 +- src/vector/ops/set.rs | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 354597fe..a7ddff29 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,4 @@ # gtags GPATH GTAGS -GRTAGS \ No newline at end of file +GRTAGS diff --git a/src/vector/ops/set.rs b/src/vector/ops/set.rs index 675138db..fc3a6d39 100644 --- a/src/vector/ops/set.rs +++ b/src/vector/ops/set.rs @@ -14,8 +14,8 @@ impl Geometry { /// otherwise the result might be wrong. /// /// # Returns - /// Some(Geometry) if both Geometries contain pointers - /// None if either geometry is missing the gdal pointer, or there is an error. + /// `Some(geometry)` if both Geometries contain pointers + /// `None` if either geometry is missing the GDAL pointer, or there is an error. /// /// See: [`OGR_G_Intersection`](https://gdal.org/api/vector_c_api.html#_CPPv418OGR_G_Intersection12OGRGeometryH12OGRGeometryH) pub fn intersection(&self, other: &Self) -> Option { @@ -42,10 +42,10 @@ impl Geometry { /// otherwise the result might be wrong. /// /// # Returns - /// Some(Geometry) if both Geometries contain pointers - /// None if either geometry is missing the gdal pointer, or there is an error. + /// `Some(geometry)` if both Geometries contain pointers. + /// `None` if either geometry is missing the GDAL pointer, or there is an error. /// - /// See: [`OGR_G_Intersection`](https://gdal.org/api/vector_c_api.html#_OGRGeometryH OGR_G_Union(OGRGeometryH, OGRGeometryH)) + /// See: [`OGR_G_Union`](https://gdal.org/api/vector_c_api.html#_CPPv419OGR_G_UnionCascaded12OGRGeometryH) pub fn union(&self, other: &Self) -> Option { if !self.has_gdal_ptr() { return None;