Skip to content

Commit 8a759d2

Browse files
candid82candid82
committed
Update docs
1 parent d9e5b54 commit 8a759d2

File tree

4 files changed

+123
-0
lines changed

4 files changed

+123
-0
lines changed

‎docs/index.html

+9
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ <h2>Index</h2>
1919
<li>
2020
<a href="#joker.json">joker.json</a>
2121
</li>
22+
<li>
23+
<a href="#joker.math">joker.math</a>
24+
</li>
2225
<li>
2326
<a href="#joker.os">joker.os</a>
2427
</li>
@@ -58,6 +61,12 @@ <h3 id="joker.json">joker.json</h3>
5861
<p class="var-docstr">Implements encoding and decoding of JSON as defined in RFC 4627.</p>
5962
<a href="joker.json.html">details</a>
6063
</li>
64+
<li>
65+
<h3 id="joker.math">joker.math</h3>
66+
<span class="var-added">v1.0</span>
67+
<p class="var-docstr">Provides basic constants and mathematical functions.</p>
68+
<a href="joker.math.html">details</a>
69+
</li>
6170
<li>
6271
<h3 id="joker.os">joker.os</h3>
6372
<span class="var-added">v1.0</span>

‎docs/joker.base64.html

+12
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ <h2>Index</h2>
1212
<li>
1313
<a href="#decode-string">decode-string</a>
1414
</li>
15+
<li>
16+
<a href="#encode-string">encode-string</a>
17+
</li>
1518

1619
</ul>
1720
<ul>
@@ -23,6 +26,15 @@ <h3 id="decode-string">decode-string</h3>
2326
</pre>
2427
<p class="var-docstr">Returns the bytes represented by the base64 string s.</p>
2528

29+
</li>
30+
<li>
31+
<h3 id="encode-string">encode-string</h3>
32+
<span class="var-type Function">Function</span>
33+
<span class="var-added">v1.0</span>
34+
<pre class="var-usage"><div><code>(encode-string s)</code></div>
35+
</pre>
36+
<p class="var-docstr">Returns the base64 encoding of s.</p>
37+
2638
</li>
2739

2840
</ul>

‎docs/joker.math.html

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<html>
2+
<head>
3+
<link rel="stylesheet" type="text/css" href="main.css">
4+
</head>
5+
<body>
6+
<div class="main">
7+
<h1>Namespace: joker.math</h1>
8+
<span class="var-added">v1.0</span>
9+
<p class="var-docstr">Provides basic constants and mathematical functions.</p>
10+
<h2>Index</h2>
11+
<ul class="index">
12+
<li>
13+
<a href="#cos">cos</a>
14+
</li>
15+
<li>
16+
<a href="#hypot">hypot</a>
17+
</li>
18+
<li>
19+
<a href="#pi">pi</a>
20+
</li>
21+
<li>
22+
<a href="#sin">sin</a>
23+
</li>
24+
25+
</ul>
26+
<ul>
27+
<li>
28+
<h3 id="cos">cos</h3>
29+
<span class="var-type Function">Function</span>
30+
<span class="var-added">v1.0</span>
31+
<pre class="var-usage"><div><code>(cos x)</code></div>
32+
</pre>
33+
<p class="var-docstr">Returns the cosine of the radian argument x.</p>
34+
35+
</li>
36+
<li>
37+
<h3 id="hypot">hypot</h3>
38+
<span class="var-type Function">Function</span>
39+
<span class="var-added">v1.0</span>
40+
<pre class="var-usage"><div><code>(hypot p q)</code></div>
41+
</pre>
42+
<p class="var-docstr">Returns Sqrt(p*p + q*q), taking care to avoid unnecessary overflow and underflow.</p>
43+
44+
</li>
45+
<li>
46+
<h3 id="pi">pi</h3>
47+
<span class="var-type Double">Double</span>
48+
<span class="var-added">v1.0</span>
49+
<pre class="var-usage"></pre>
50+
<p class="var-docstr">Mathematical constant Pi.</p>
51+
<a href="https://github.com/candid82/joker/blob/master/core/data/core.joke#L3">source</a>
52+
</li>
53+
<li>
54+
<h3 id="sin">sin</h3>
55+
<span class="var-type Function">Function</span>
56+
<span class="var-added">v1.0</span>
57+
<pre class="var-usage"><div><code>(sin x)</code></div>
58+
</pre>
59+
<p class="var-docstr">Returns the sine of the radian argument x.</p>
60+
61+
</li>
62+
63+
</ul>
64+
</div>
65+
</body>
66+
</html>

‎docs/joker.os.html

+36
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,21 @@ <h2>Index</h2>
1212
<li>
1313
<a href="#args">args</a>
1414
</li>
15+
<li>
16+
<a href="#cwd">cwd</a>
17+
</li>
1518
<li>
1619
<a href="#env">env</a>
1720
</li>
1821
<li>
1922
<a href="#exit">exit</a>
2023
</li>
24+
<li>
25+
<a href="#ls">ls</a>
26+
</li>
27+
<li>
28+
<a href="#mkdir">mkdir</a>
29+
</li>
2130
<li>
2231
<a href="#sh">sh</a>
2332
</li>
@@ -32,6 +41,15 @@ <h3 id="args">args</h3>
3241
</pre>
3342
<p class="var-docstr">Returns a sequence of the command line arguments, starting with the program name (normally, joker).</p>
3443

44+
</li>
45+
<li>
46+
<h3 id="cwd">cwd</h3>
47+
<span class="var-type Function">Function</span>
48+
<span class="var-added">v1.0</span>
49+
<pre class="var-usage"><div><code>(cwd)</code></div>
50+
</pre>
51+
<p class="var-docstr">Returns a rooted path name corresponding to the current directory. If the current directory can<br> be reached via multiple paths (due to symbolic links), cwd may return any one of them.</p>
52+
3553
</li>
3654
<li>
3755
<h3 id="env">env</h3>
@@ -50,6 +68,24 @@ <h3 id="exit">exit</h3>
5068
</pre>
5169
<p class="var-docstr">Causes the current program to exit with the given status code.</p>
5270

71+
</li>
72+
<li>
73+
<h3 id="ls">ls</h3>
74+
<span class="var-type Function">Function</span>
75+
<span class="var-added">v1.0</span>
76+
<pre class="var-usage"><div><code>(ls dirname)</code></div>
77+
</pre>
78+
<p class="var-docstr">Reads the directory named by dirname and returns a list of directory entries sorted by filename.</p>
79+
80+
</li>
81+
<li>
82+
<h3 id="mkdir">mkdir</h3>
83+
<span class="var-type Function">Function</span>
84+
<span class="var-added">v1.0</span>
85+
<pre class="var-usage"><div><code>(mkdir name perm)</code></div>
86+
</pre>
87+
<p class="var-docstr">Creates a new directory with the specified name and permission bits.</p>
88+
5389
</li>
5490
<li>
5591
<h3 id="sh">sh</h3>

0 commit comments

Comments
 (0)