diff --git a/CHANGELOG.md b/CHANGELOG.md index cdbf608..4b307f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] +### Changed +- Improved documentation on `Map::layers` and `Map::get_layer`. (#306) + ## [0.12.0] ### Added - Add `text`, `width` and `height` members to `ObjectShape::Text`. (#278) diff --git a/src/map.rs b/src/map.rs index 92ed0c1..37b2503 100644 --- a/src/map.rs +++ b/src/map.rs @@ -108,7 +108,10 @@ impl Map { self.tilesets.as_ref() } - /// Get an iterator over all the layers in the map in ascending order of their layer index. + /// Get an iterator over top-level layers in the map in ascending order of their layer index. + /// + /// Note: "top-level" means that if a map has layers of `LayerDataType::Group` type, you + /// need to recursively enumerate those group layers. /// /// ## Example /// ``` @@ -139,7 +142,7 @@ impl Map { self.layers.iter().map(move |layer| Layer::new(self, layer)) } - /// Returns the layer that has the specified index, if it exists. + /// Returns the top-level layer that has the specified index, if it exists. pub fn get_layer(&self, index: usize) -> Option { self.layers.get(index).map(|data| Layer::new(self, data)) }