Write docs

This commit is contained in:
Jeff 2023-08-28 10:12:41 -04:00
parent 97ebe63f97
commit b48974224d
3 changed files with 12 additions and 2 deletions

4
Cargo.lock generated
View File

@ -925,8 +925,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9ea835d29036a4087793836fa931b08837ad5e957da9e23886b29586fb9b6650" checksum = "9ea835d29036a4087793836fa931b08837ad5e957da9e23886b29586fb9b6650"
[[package]] [[package]]
name = "dust" name = "dust-lang"
version = "0.3.0" version = "0.1.0"
dependencies = [ dependencies = [
"chrono", "chrono",
"clap", "clap",

View File

@ -1,3 +1,4 @@
//! Types that represent runtime values.
use crate::{ use crate::{
error::{Error, Result}, error::{Error, Result},
Function, Table, Time, ValueType, VariableMap, Function, Table, Time, ValueType, VariableMap,

View File

@ -1,3 +1,12 @@
//! Representation of a moment in time.
//!
//! Whale represent time values correctly. To do this, there must be a clear separation between
//! monotonic timestamps, naive times that do not know their locale and those that have a timezone.
//!
//! Only monotonic time instances are guaranteed not to repeat, although and Instance can be used to
//! create and of these variants. Users generally want the timezone included, so the `as_local` is
//! included, which will use no timezone offset if one is not available.
use std::{ use std::{
fmt::{self, Display, Formatter}, fmt::{self, Display, Formatter},
time::{Instant, SystemTime}, time::{Instant, SystemTime},