From 8a6c6c32106f213a827606b3da938fd76e7a70a5 Mon Sep 17 00:00:00 2001
From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 10 Jul 2021 15:47:40 +0100
Subject: [PATCH] zcoord: document iter()

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---
 base/zcoord.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/base/zcoord.rs b/base/zcoord.rs
index 37b38505..a04abb9c 100644
--- 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
-- 
2.30.2