carpentry/path
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: fix links between absolute? and relative?

Browse Source
This commit is contained in:
Veit Heller
2020-05-09 22:06:20 +02:00
parent 3eb542bdfd
commit 2d62dee4d0
3 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Path.html
View File

@@ -97,7 +97,7 @@ has some functions to work with the <code>PATH</code> environment variable.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>checks whether a path is absolute.</p> <p>checks whether a path is absolute.</p>
<p>As such, it is the inverse to <a href="#relative">relative</a>.</p> <p>As such, it is the inverse to <a href="#relative?">relative?</a>.</p>
</p> </p>
</div> </div>
@@ -342,7 +342,7 @@ is none.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>checks whether a path is relative.</p> <p>checks whether a path is relative.</p>
<p>As such, it is the inverse to <a href="#absolute">absolute</a>.</p> <p>As such, it is the inverse to <a href="#absolute?">absolute?</a>.</p>
</p> </p>
</div> </div>

15
gendocs.carp
View File

@@ -1,13 +1,10 @@
(load "path.carp") (load "path.carp")
(defndynamic gendocs [] (Project.config "title" "path")
(do (Project.config "docs-directory" "./docs/")
(Project.config "title" "path") (Project.config "docs-logo" "")
(Project.config "docs-directory" "./docs/") (Project.config "docs-styling" "style.css")
(Project.config "docs-logo" "") (Project.config "docs-generate-index" false)
(Project.config "docs-styling" "style.css") (save-docs Path)
(Project.config "docs-generate-index" false)
(save-docs Path)))
(gendocs)
(quit) (quit)

4
path.carp
View File

@@ -16,7 +16,7 @@ It assumes either Windows or POSIX-style separators.")
(defmodule Path (defmodule Path
(doc absolute? "checks whether a path is absolute. (doc absolute? "checks whether a path is absolute.
As such, it is the inverse to [relative](#relative).") As such, it is the inverse to [relative?](#relative?).")
(doc separator "is the default separator we use on this OS.") (doc separator "is the default separator we use on this OS.")
(doc separators "is the possible separators we could use on this OS.") (doc separators "is the possible separators we could use on this OS.")
(doc search-path-separator "is the separator for the `PATH` environment (doc search-path-separator "is the separator for the `PATH` environment
@@ -42,7 +42,7 @@ variable we use on this OS.")
(doc relative? "checks whether a path is relative. (doc relative? "checks whether a path is relative.
As such, it is the inverse to [absolute](#absolute).") As such, it is the inverse to [absolute?](#absolute?).")
(defn relative? [p] (not (absolute? p))) (defn relative? [p] (not (absolute? p)))
(doc separator? "checks whether the character `c` is a path separator on this (doc separator? "checks whether the character `c` is a path separator on this