From c60711f4b7ef979b1fbb881ef4f7c02b0e6c43f1 Mon Sep 17 00:00:00 2001 From: Michael Jones Date: Fri, 28 Jun 2024 11:18:34 +0100 Subject: [PATCH] Add module doc comment to main module --- src/rada/date.gleam | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/rada/date.gleam b/src/rada/date.gleam index ae472d8..1047715 100644 --- a/src/rada/date.gleam +++ b/src/rada/date.gleam @@ -1,3 +1,11 @@ +//// This module provides a simple [`Date`](#Date) type for working with dates without times or zones. +//// +//// The module uses the [Rata Die][ratadie] system to represent dates in the standard Gregorian Calendar. +//// The number 1 represents the date **1 January 0001** and all other dates are represented as positive +//// or negative numbers relative to that date. +//// +//// [ratadie]: https://en.wikipedia.org/wiki/Rata_Die + import gleam/bool import gleam/float import gleam/int