zcoord: document iter()

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/base/zcoord.rs b/base/zcoord.rs
index 37b38505fe3737eeb90b8941f9f2d5a98f284fe5..a04abb9cb614857ae31ede5ea48cf1051f85072e 100644 (file)
--- a/base/zcoord.rs
+++ b/base/zcoord.rs
@@ -451,12 +451,14 @@ pub type BoxedIterator = Box<dyn BoxedIteratorTrait>;
 impl<T> BoxedIteratorTrait for T where T: Iterator<Item = ZCoord> + Debug {}
 
 impl Mutable {
+  /// Iterator producing `<self, ..>`
   pub fn iter<ASO:AddSubOffset>(self, aso: ASO)
                                 -> IteratorCore<ASO, impl MutateReturn + Debug>
   {
     IteratorCore { current: self, aso, mr: MutateFirst }
   }
   #[throws(LogicError)]
+  /// Iterator producing a half-open range, `[a, b)`
   pub fn some_range(a: Option<&Mutable>, b: Option<&Mutable>,
                     count: RangeCount) -> BoxedIterator {
     fn mk<T:'static + Debug + Iterator<Item=ZCoord>>(x: T) -> BoxedIterator