aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2026-08-17 20:25:38 +0200
committerDaniel Schadt <kingdread@gmx.de>2026-08-17 20:25:38 +0200
commitce81087037956f2a33f550585f32d0070039ade0 (patch)
tree5282867e2e98d79a65f88c9ca7ccab97d4d2e10e
parent182f3366fbbe9d00d3a25c630199d91dd307e771 (diff)
downloadhittekaart-ce81087037956f2a33f550585f32d0070039ade0.tar.gz
hittekaart-ce81087037956f2a33f550585f32d0070039ade0.tar.bz2
hittekaart-ce81087037956f2a33f550585f32d0070039ade0.zip
add docstrings for with_name/with_description
-rw-r--r--hittekaart/src/storage.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/hittekaart/src/storage.rs b/hittekaart/src/storage.rs
index d52a900..5c2d453 100644
--- a/hittekaart/src/storage.rs
+++ b/hittekaart/src/storage.rs
@@ -283,6 +283,9 @@ impl MbTiles {
})
}
+ /// Set the name of this MBTiles tile store.
+ ///
+ /// The default name is `"Heatmap"`.
pub fn with_name(self, name: String) -> Self {
MbTiles {
name,
@@ -290,6 +293,10 @@ impl MbTiles {
}
}
+ /// Set (or unset) the description of this MBTiles tile store.
+ ///
+ /// By default, no description will be written. If a description has been set, it can be
+ /// removed by using `with_description(None)`.
pub fn with_description(self, description: Option<String>) -> Self {
MbTiles {
description,