Added comments

2023-04-07 20:55:23 -07:00 · 2023-04-07 20:55:23 -07:00 · 1e04b15b46
parent 8982b3b118
commit 1e04b15b46
1 changed files with 17 additions and 0 deletions
--- a/src/quantity/mod.rs
+++ b/src/quantity/mod.rs
@ -7,6 +7,23 @@ use std::ops::{
 };


+/*
+Quantity:
+	Represents a value with a unit attached to it.
+Units have yet to be implemented.
+
+f64q: a quantity based on plain f64s
+floatq: a quantity using rug bigfloat
+rationalq: a quantity using rug rationals
+
+All of the above are ONLY used for values.
+There is only one kind of unit type.
+
+
+The cfg_if blocks here are a temporary hack to allow for
+cross-compilation to other systems. RUG does not work on all systems.
+*/
+
 pub mod quantity;

 cfg_if::cfg_if! {