Skip to content

Commit 8c0ceec

Browse files
committed
adding template for documentation, will need to fill them up
1 parent 41580ad commit 8c0ceec

File tree

2 files changed

+101
-7
lines changed

2 files changed

+101
-7
lines changed

Math.ark

Lines changed: 56 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,74 @@
1-
# @author: https://github.com/rstefanic
1+
###
2+
# @meta Mathematics
3+
# @brief
4+
# ---
5+
# ---
6+
# @param
7+
# @author https://github.com/rstefanic
8+
###
29
(let math:abs (fun (_x)
310
(if (< _x 0) (* -1 _x) _x)))
411

5-
# @author: https://github.com/rstefanic
12+
###
13+
# @meta Mathematics
14+
# @brief
15+
# ---
16+
# ---
17+
# @param
18+
# @author https://github.com/rstefanic
19+
###
620
(let math:even (fun (_n)
721
(= 0 (mod _n 2))))
822

9-
# @author: https://github.com/rstefanic
23+
###
24+
# @meta Mathematics
25+
# @brief
26+
# ---
27+
# ---
28+
# @param
29+
# @author https://github.com/rstefanic
30+
###
1031
(let math:odd (fun (_n)
1132
(= 1 (math:abs (mod _n 2)))))
1233

13-
# @author: https://github.com/rstefanic
34+
###
35+
# @meta Mathematics
36+
# @brief
37+
# ---
38+
# ---
39+
# @param
40+
# @author https://github.com/rstefanic
41+
###
1442
(let math:min (fun (_a _b)
1543
(if (< _a _b) _a _b)))
1644

17-
# @author: https://github.com/rstefanic
45+
###
46+
# @meta Mathematics
47+
# @brief
48+
# ---
49+
# ---
50+
# @param
51+
# @author https://github.com/rstefanic
52+
###
1853
(let math:max (fun (_a _b)
1954
(if (> _a _b) _a _b)))
2055

21-
# @author: https://github.com/SuperFola
56+
###
57+
# @meta Mathematics
58+
# @brief
59+
# ---
60+
# ---
61+
# @param
62+
# @author https://github.com/SuperFola
63+
###
2264
(let math:pow (fun (x _a) (math:exp (* _a (math:ln x)))))
2365

24-
# @author: https://github.com/SuperFola
66+
###
67+
# @meta Mathematics
68+
# @brief
69+
# ---
70+
# ---
71+
# @param
72+
# @author https://github.com/SuperFola
73+
###
2574
(let math:sqrt (fun (x) (math:exp (* 0.5 (math:ln x)))))

Range.ark

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
###
2+
# @meta Range
3+
# @brief
4+
# @details
5+
# ---
6+
# ---
7+
# @param
8+
# @author https://github.com/SuperFola
9+
###
110
(let range (fun (_a _b) {
211
(let asList (fun () {
312
# _a and _b are going to be captured by the caller
@@ -19,6 +28,15 @@
1928
})
2029
}))
2130

31+
###
32+
# @meta Range
33+
# @brief
34+
# @details
35+
# ---
36+
# ---
37+
# @param
38+
# @author https://github.com/SuperFola
39+
###
2240
(let range:forEach (fun (_r _f) {
2341
(mut _val (_r))
2442
(while (not (nil?_ val)) {
@@ -27,6 +45,15 @@
2745
})
2846
}))
2947

48+
###
49+
# @meta Range
50+
# @brief
51+
# @details
52+
# ---
53+
# ---
54+
# @param
55+
# @author https://github.com/SuperFola
56+
###
3057
(let range:filter (fun (_range _fun) {
3158
(mut _value (_range))
3259
(mut _output [])
@@ -38,6 +65,15 @@
3865
_output
3966
}))
4067

68+
###
69+
# @meta Range
70+
# @brief
71+
# @details
72+
# ---
73+
# ---
74+
# @param
75+
# @author https://github.com/SuperFola
76+
###
4177
(let range:map (fun (_range _fun) {
4278
(mut _value (_range))
4379
(mut _output [])
@@ -49,6 +85,15 @@
4985
_output
5086
}))
5187

88+
###
89+
# @meta Range
90+
# @brief
91+
# @details
92+
# ---
93+
# ---
94+
# @param
95+
# @author https://github.com/SuperFola
96+
###
5297
(let range:reduce (fun (_range _fun) {
5398
(mut _output (_range))
5499
(mut _last (_range))

0 commit comments

Comments
 (0)