From 93ac89e2f8a47e412dcb6b6944c5e39b3ea073f0 Mon Sep 17 00:00:00 2001 From: Eduardo Julian Date: Sun, 9 Dec 2018 17:11:38 -0400 Subject: Added some missing/necessary documentation. --- stdlib/source/lux/control/security/taint.lux | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'stdlib/source/lux/control/security/taint.lux') diff --git a/stdlib/source/lux/control/security/taint.lux b/stdlib/source/lux/control/security/taint.lux index afdc1904c..9234baa97 100644 --- a/stdlib/source/lux/control/security/taint.lux +++ b/stdlib/source/lux/control/security/taint.lux @@ -10,17 +10,23 @@ abstract]]) (abstract: #export (Dirty a) + {#.doc (doc "A value which is considered untrustworthy due to its origin.")} + a (def: #export taint + {#.doc (doc "Mark a value as dirty/untrustworthy.")} (All [a] (-> a (Dirty a))) (|>> :abstraction)) (def: #export (validate validator dirty) + {#.doc (doc "Test a dirty/untrustworthy value." + "Potentially produces a 'clean' value.")} (All [a b] (-> (-> a (Error b)) (Dirty a) (Error b))) (validator (:representation dirty))) (def: #export trust + {#.doc (doc "Trusts a (previously thought as) dirty/untrustworthy value.")} (All [a] (-> (Dirty a) a)) (|>> :representation)) -- cgit v1.2.3