From 03aab46ab5e50371425a404da26db9bee29a8ca2 Mon Sep 17 00:00:00 2001 From: hellerve Date: Tue, 19 Jan 2021 10:56:58 +0100 Subject: [PATCH] update docs --- README.md | 2 +- docs/Path.html | 58 +++++++++++++++++++++----------------------------- path.carp | 2 +- 3 files changed, 26 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index c764240..476b280 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ is a simple file path library for Carp. ## Installation ```clojure -(load "https://veitheller.de/git/carpentry/path@0.0.2") +(load "https://veitheller.de/git/carpentry/path@0.0.3") ``` ### Usage diff --git a/docs/Path.html b/docs/Path.html index 02a06b2..5bb0cee 100644 --- a/docs/Path.html +++ b/docs/Path.html @@ -9,8 +9,8 @@
@@ -90,7 +80,7 @@ has some functions to work with the PATH environment variable.

defn

- (λ [(Ref String a)] Bool) + (Fn [(Ref String a)] Bool) 

                     (absolute? p)
@@ -111,7 +101,7 @@ has some functions to work with the PATH environment variable.

                     defn

- (λ [(Ref String a), (Ref String b)] String) + (Fn [(Ref String a), (Ref String b)] String) 

                     (add-extension p ext)
@@ -131,7 +121,7 @@ has some functions to work with the PATH environment variable.

                     defn
                 
                 

-                    (λ [(Ref String a)] String)
+                    (Fn [(Ref String a)] String)
                 

                 
                     (basename p)
@@ -151,7 +141,7 @@ has some functions to work with the PATH environment variable.

                     defn
                 
                 

-                    (λ [] (Maybe String))
+                    (Fn [] (Maybe String))
                 

                 
                     (cwd)
@@ -172,7 +162,7 @@ which it can fail are OS-dependent, but it should happen relatively rare.

                     defn
                 
                 

-                    (λ [(Ref String a)] String)
+                    (Fn [(Ref String a)] String)
                 

                 
                     (drop-extension p)
@@ -193,7 +183,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a)] (Maybe String))
+                    (Fn [(Ref String a)] (Maybe String))
                 

                 
                     (extension p)
@@ -213,7 +203,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a)] (Maybe String))
+                    (Fn [(Ref String a)] (Maybe String))
                 

                 
                     (filename p)
@@ -234,7 +224,7 @@ is none.

                     defn
                 
                 

-                    (λ [] (Maybe (Array String)))
+                    (Fn [] (Maybe (Array String)))
                 

                 
                     (get-search-path)
@@ -254,7 +244,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a)] Bool)
+                    (Fn [(Ref String a)] Bool)
                 

                 
                     (has-extension? p)
@@ -274,7 +264,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a), (Ref String b)] Bool)
+                    (Fn [(Ref String a), (Ref String b)] Bool)
                 

                 
                     (is-extension? p ext)
@@ -294,7 +284,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref (Array String) a)] String)
+                    (Fn [(Ref (Array String) a)] String)
                 

                 
                     (join ps)
@@ -335,7 +325,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a)] Bool)
+                    (Fn [(Ref String a)] Bool)
                 

                 
                     (relative? p)
@@ -356,7 +346,7 @@ is none.

                     defn
                 
                 

-                    (λ [(Ref String a), (Ref String b)] String)
+                    (Fn [(Ref String a), (Ref String b)] String)
                 

                 
                     (replace-extension p ext)
@@ -398,7 +388,7 @@ variable we use on this OS.

                     defn
                 
                 

-                    (λ [Char] Bool)
+                    (Fn [Char] Bool)
                 

                 
                     (search-path-separator? c)
@@ -437,7 +427,7 @@ variable we use on this OS.

                     defn
                 
                 

-                    (λ [(Ref Char StaticLifetime)] Bool)
+                    (Fn [(Ref Char StaticLifetime)] Bool)
                 

                 
                     (separator? c)
@@ -478,7 +468,7 @@ variable we use on this OS.

                     defn
                 
                 

-                    (λ [(Ref String a)] (Array String))
+                    (Fn [(Ref String a)] (Array String))
                 

                 
                     (split p)
@@ -499,7 +489,7 @@ variable we use on this OS.

                     defn
                 
                 

-                    (λ [(Ref String a)] (Maybe (Pair String String)))
+                    (Fn [(Ref String a)] (Maybe (Pair String String)))
                 

                 
                     (split-extension p)
@@ -536,7 +526,7 @@ the extension.

                     defn
                 
                 

-                    (λ [(Ref String a)] (Array String))
+                    (Fn [(Ref String a)] (Array String))
                 

                 
                     (split-search-path p)
diff --git a/path.carp b/path.carp
index c4055b3..2bf5f14 100644
--- a/path.carp
+++ b/path.carp
@@ -3,7 +3,7 @@
 ## Installation
 
 ```clojure
-(load \"https://veitheller.de/git/carpentry/path@0.0.2\")
+(load \"https://veitheller.de/git/carpentry/path@0.0.3\")
 ```
 
 ### Usage