docs: categorize Language Definition functions #452
Conversation
- multi-type / misc functions - Type Conversion functions - String functions - Date functions - Number functions - Array functions - Map functions - also consistently use `str`, `array`, `n`, `v` for the variable name when referring to a specific type - `array` was used consistently for older functions, but not some newer ones - `str` added to match `array` - `n` was sometimes used for numbers or ints, but not always - `v` is for multi-type "values" Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
docs/Language-Definition.md
Outdated
|
|
||
| Returns **true** if _all elements does not_ satisfy the [predicate](#predicate). | ||
| If the array is empty, returns **true**. | ||
| #### Type Conversion Functions |
There was a problem hiding this comment.
Let's keep categories on the second level. ##.
There was a problem hiding this comment.
If Categories will be at the second level, should we remove the ## Built-in Functions heading that these are all currently under?
There was a problem hiding this comment.
Renamed it to "Miscellaneous Functions" as if everything else is an h2, this only has the misc functions in it. And I moved misc to the bottom of the functions list since they are miscellaneous
|
I like the idea. |
- categories to h2, individual functions to h3 per review feedback - rename "Built-in Functions" -> "Miscellaneous Functions" as this is now only around the uncategorized functions - move this to the bottom of the function list as well so that "miscellaneous" is not first - combine "Date Manipulation" with "Date Functions" Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
|
made some adjustments per feedback |
|
Lets also rearrange order: string function, number funcs, array, date, type, misc. |
where would you like to place map functions? also I put date functions right after string because technically they are all strings as well |
… review Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
|
I modified it to string > date > number > array > map > type > misc. Let me know if that's alright or you want more changes |
|
Done! https://expr.medv.io/docs/Language-Definition Thanks for the awesome contribution. |
|
new heading index looks great 😄 : |
Motivation
Since 1.14 and 1.15 added a bunch of new operators / functions, I thought that categorizing them would help discoverability
Modifications
new categories / section headings
also consistently use
str,array,map,n,vfor the variable name when referring to a specific typearraywas used consistently for older functions, but not some newer onesstradded to matcharraynwas sometimes used for numbers or ints, but not alwaysvis for multi-type "values"Validation
Read through in markdown previewer to double check
Notes for Reviewers
Feel free to reject this if you'd rather keep it uncategorized! Categories are subjective, after all, so preferences can differ.
Also feel free to recommend other categorizations or re-categorizations!