From a6e3e58877307d7c9113fb229d46ada5f165eadc Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Wed, 18 Jan 2023 20:46:26 +0100 Subject: add some more docstrings --- src/lib.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 670678f..d6a6a46 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,10 @@ -//! This is a stub library for `hittekaart` to expose the functions for benchmarking. +//! `hittekaart` is a program to generate heatmaps from GPX tracks. +//! +//! Note that this crate is not meant to be used as a library. Instead, use the command line +//! program that is included in this crate. +//! +//! This library therefore contains an API that is tailored to the use case of the `hittekaart` +//! binary. pub mod gpx; pub mod layer; pub mod renderer; -- cgit v1.2.3