Skip to content

Commit fdeca22

Browse files
committed
Improve documentation
1 parent 85ee9e2 commit fdeca22

6 files changed

Lines changed: 299 additions & 143 deletions

File tree

README.md

Lines changed: 29 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,13 @@ Returns the common elements of two arrays or slices.
124124
intersect SET1 SET2
125125
```
126126

127-
#### isSet,isset
127+
#### union
128+
Given two arrays or slices, returns a new array that contains the elements or objects that belong to either or both arrays/slices.
129+
```
130+
union SET1 SET2
131+
```
132+
133+
#### isset
128134
Returns true if the parameter is set.
129135
```
130136
isset COLLECTION INDEX
@@ -144,12 +150,6 @@ Returns a random permutation of a given array or slice.
144150
shuffle COLLECTION
145151
```
146152

147-
#### union
148-
Given two arrays or slices, returns a new array that contains the elements or objects that belong to either or both arrays/slices.
149-
```
150-
union SET1 SET2
151-
```
152-
153153
#### where
154154
Filters an array to only the elements containing a matching value for a given field.
155155
```
@@ -230,28 +230,22 @@ Add adds two numbers
230230
add INPUT1 INPUT2
231231
```
232232

233-
#### math.Ceil
234-
Returns the least integer value greater than or equal to the given number.
235-
```
236-
math.Ceil FLOAT
237-
```
238-
239-
#### div
240-
Divides two numbers.
233+
#### sub
234+
Subtracts two numbers.
241235
```
242-
div INPUT1 INPUT2
236+
sub INPUT1 INPUT2
243237
```
244238

245-
#### math.Floor
246-
Returns the greatest integer value less than or equal to the given number.
239+
#### mul
240+
Multiplies two numbers.
247241
```
248-
math.Floor FLOAT
242+
mul INPUT1 INPUT2
249243
```
250244

251-
#### math.Log
252-
Log returns the natural logarithm of a number.
245+
#### div
246+
Divides two numbers.
253247
```
254-
math.Log FLOAT
248+
div INPUT1 INPUT2
255249
```
256250

257251
#### mod
@@ -266,10 +260,16 @@ Boolean of modulus of two integers. Evaluates to `true` if `INT1%INT2` equals 0.
266260
modBool INT1 INT2
267261
```
268262

269-
#### mul
270-
Multiplies two numbers.
263+
#### math.Ceil
264+
Returns the least integer value greater than or equal to the given number.
271265
```
272-
mul INPUT1 INPUT2
266+
math.Ceil FLOAT
267+
```
268+
269+
#### math.Floor
270+
Returns the greatest integer value less than or equal to the given number.
271+
```
272+
math.Floor FLOAT
273273
```
274274

275275
#### math.Round
@@ -278,10 +278,10 @@ Returns the nearest integer, rounding half away from zero.
278278
math.Round FLOAT
279279
```
280280

281-
#### sub
282-
Subtracts two numbers.
281+
#### math.Log
282+
Log returns the natural logarithm of a number.
283283
```
284-
sub INPUT1 INPUT2
284+
math.Log FLOAT
285285
```
286286

287287
---
@@ -398,12 +398,6 @@ Replaces all occurrences of a regular expression with the replacement pattern.
398398
replaceRE PATTERN REPLACEMENT INPUT
399399
```
400400

401-
#### slicestr
402-
Creates a slice of a half-open range, including start and end indices.
403-
```
404-
slicestr STRING START [END]
405-
```
406-
407401
#### split
408402
splits a string into substrings separated by a delimiter
409403
```
@@ -523,7 +517,7 @@ You can find a number of ready-to-run examples at [SOHA examples repository](exa
523517

524518
## Acknowledgements
525519

526-
Thanks to [HUGO](https://github.com/gohugoio/hugo),SOHA extracted HUGO's template functions and modified them.
520+
Thanks to [HUGO](https://github.com/gohugoio/hugo),SOHA extracted HUGO's template functions and Enhance them.
527521

528522
## License
529523

0 commit comments

Comments
 (0)