Updated inline documentation of the modules (includes link to Github …

…and ReadThedoc)
CryptoPascal31 · Oct 16, 2022 · 9958c6f · 9958c6f
1 parent 9798862
commit 9958c6f
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/pact/contracts/util-lists.pact b/pact/contracts/util-lists.pact
@@ -11,7 +11,10 @@
 ; https://github.com/CryptoPascal31/pact-util-lib
 
 (module util-lists GOV
-  "Module containing string utilities"
+  "This module provides some lists management utilities \
+   \ Documentation: https://pact-util-lib.readthedocs.io \
+   \ Github: https://github.com/CryptoPascal31/pact-util-lib "
+
   (defconst VERSION:string "0.1")
 
   (defcap GOV()

diff --git a/pact/contracts/util-math.pact b/pact/contracts/util-math.pact
@@ -10,7 +10,10 @@
 ; https://github.com/CryptoPascal31/pact-util-lib
 
 (module util-math GOV
-  "Module containing math utilities"
+  "Module containing math utilities \
+   \ Documentation: https://pact-util-lib.readthedocs.io \
+   \ Github: https://github.com/CryptoPascal31/pact-util-lib "
+
   (defconst VERSION:string "0.1")
 
   (defcap GOV()

diff --git a/pact/contracts/util-random.pact b/pact/contracts/util-random.pact
@@ -19,6 +19,9 @@
 ; https://github.com/CryptoPascal31/pact-util-lib
 
 (module util-random GOV
+  "This module provides pseudo-random numbers/string generation \
+   \ Documentation: https://pact-util-lib.readthedocs.io \
+   \ Github: https://github.com/CryptoPascal31/pact-util-lib "
   (defconst VERSION:string "0.1")
   (defcap GOV()
     (enforce-keyset "free.util-lib"))

diff --git a/pact/contracts/util-strings.pact b/pact/contracts/util-strings.pact
@@ -14,6 +14,10 @@
 ; https://github.com/CryptoPascal31/pact-util-lib
 
 (module util-strings GOV
+  "This module provides some strings management utilities \
+   \ Documentation: https://pact-util-lib.readthedocs.io \
+   \ Github: https://github.com/CryptoPascal31/pact-util-lib "
+
   (defconst VERSION:string "0.1")
   (defcap GOV()
     (enforce-keyset "free.util-lib"))