Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #743

Merged
merged 27 commits into from
Sep 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ jobs:
./docgen -panic -warning -config gen/docgen.yaml
mv -v *.md *.svg docs/
mv -v gen/vuepress docs/.vuepress

for f in $(find docs -type f -regex '.*?/[-_A-Z]+\..*'); do
mv -v "$f" "$(echo $f | tr '[A-Z]' '[a-z]')"
done

- name: Install pnpm
uses: pnpm/action-setup@v2
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,9 @@ murex.iml

# Codecov.io
coverage.txt

# viewpress
node_modules/
docs/.vuepress/.temp/
docs/.vuepress/.cache/
docs/.vuepress/dist/
4 changes: 2 additions & 2 deletions builtins/core/arraytools/2darray_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@
- ja
- jsplit
- count
- index
- item-index
- range
- mtac
- msort
- types/json
- json
2 changes: 1 addition & 1 deletion builtins/core/arraytools/addheading_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
Detail:
Synonyms:
Related:
- index
- item-index
- element
- cast
- append
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/arraytools/map_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@
- jsplit
- range
- alter
- index
- item-index
- element
4 changes: 2 additions & 2 deletions builtins/core/autocomplete/autocomplete_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
- function
- alias
- summary
- types/mxjson
- index
- mxjson
- item-index
- get-type
- switch
- stdin
4 changes: 2 additions & 2 deletions builtins/core/config/config_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@
- runtime
- open
- event
- types/mxjson
- mxjson
- append
- function
- match
- get
- post
- getfile
- index
- item-index
- element

2 changes: 1 addition & 1 deletion builtins/core/datatools/alter_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
"-s" : Alias for `--sum`
Synonyms:
Related:
- index
- item-index
- element
- format
- append
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/datatools/count_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
- ja
- ta
- jsplit
- index
- item-index
- element
- range
- mtac
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/datatools/structkeys_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
Synonyms:
Related:
- set
- index
- item-index
- element
- formap

6 changes: 3 additions & 3 deletions builtins/core/element/element_doc.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- DocumentID: element
Title: >+
`[[` (element)
CategoryID: commands
`[[ element ]]`
CategoryID: parser
Summary: >-
Outputs an element from a nested structure
Description: |-
Expand Down Expand Up @@ -114,5 +114,5 @@
- a
- ja
- mtac
- index
- item-index
- config
2 changes: 1 addition & 1 deletion builtins/core/escape/escape_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
Related:
- alias
- out
- index
- item-index
- escape
- eschtml
- escurl
2 changes: 1 addition & 1 deletion builtins/core/httpclient/get_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
Synonyms:
Related:
- post
- index
- item-index
- element
- getfile
- config
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/httpclient/post_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
Synonyms:
Related:
- get
- index
- item-index
- element
- getfile
- config
Expand Down
5 changes: 3 additions & 2 deletions builtins/core/index/index_doc.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- DocumentID: item-index
Title: >+
`[` (index)
CategoryID: commands
`[index]`
CategoryID: parser
Summary: >-
Outputs an element from an array, map or table
Description: |-
Expand Down Expand Up @@ -119,6 +119,7 @@
Synonyms:
- "["
- "!["
- item-index
- index
Related:
- range
Expand Down
22 changes: 11 additions & 11 deletions builtins/core/io/echo_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@
Related:
- tout
- err
- brace-quote
- brace-quote-func
- cast
- greater-than
- greater-than-greater-than
- pt
- read
- tread
- user-guide/ansi
- ansi

- DocumentID: tout
Title: >+
Expand Down Expand Up @@ -73,18 +73,18 @@
Related:
- out
- err
- brace-quote
- brace-quote-func
- cast
- pretty
- format
- user-guide/ansi
- ansi

- DocumentID: brace-quote
- DocumentID: brace-quote-func
Title: >+
`(` (brace quote)
CategoryID: commands
`(brace quote)`
CategoryID: parser
Summary: >-
Write a string to the STDOUT without new line
Write a string to the STDOUT without new line (deprecated)
Description: |-
Write parameters to STDOUT (does not include a new line)
Usage: |-
Expand Down Expand Up @@ -126,7 +126,7 @@
- greater-than
- greater-than-greater-than
- pt
- user-guide/ansi
- ansi

- DocumentID: err
Title: >+
Expand Down Expand Up @@ -177,13 +177,13 @@
Related:
- tout
- out
- brace-quote
- brace-quote-func
- cast
- bg
- pipe
- pretty
- greater-than
- greater-than-greater-than
- pt
- user-guide/ansi
- ansi
- namedpipe
2 changes: 1 addition & 1 deletion builtins/core/io/f_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@
Related:
- g
- rx
- types/json
- json
22 changes: 11 additions & 11 deletions builtins/core/io/file_doc.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- DocumentID: greater-than
Title: >+
`>` (truncate file)
CategoryID: commands
`|>` (truncate file)
CategoryID: parser
Summary: >-
Writes STDIN to disk - overwriting contents if file already exists
Description: |-
Expand All @@ -26,15 +26,15 @@
- pipe
- g
- tmp
- parser/pipe-arrow
- parser/pipe-posix
- commands/namedpipe
- parser/pipe-err
- pipe-arrow
- pipe-posix
- namedpipe
- pipe-err

- DocumentID: greater-than-greater-than
Title: >+
`>>` (append file)
CategoryID: commands
CategoryID: parser
Summary: >-
Writes STDIN to disk - appending contents if file already exists
Description: |-
Expand All @@ -59,10 +59,10 @@
- pipe
- g
- tmp
- parser/pipe-arrow
- parser/pipe-posix
- commands/namedpipe
- parser/pipe-err
- pipe-arrow
- pipe-posix
- namedpipe
- pipe-err

- DocumentID: pt
Title: >+
Expand Down
6 changes: 3 additions & 3 deletions builtins/core/lists/append_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
- prepend
- list.prepend
Related:
- index
- item-index
- element
- cast
- append
Expand Down Expand Up @@ -86,15 +86,15 @@
- append
- list.append
Related:
- index
- item-index
- element
- cast
- prepend
- addheading
- a
- ja
- count
- index
- item-index
- range
- mtac
- msort
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/lists/jsplit_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
- ja
- 2darray
- count
- index
- item-index
- element
- range
- mtac
Expand Down
2 changes: 1 addition & 1 deletion builtins/core/lists/msort_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@
- range
- alter
- mtac
- index
- item-index
- element
16 changes: 8 additions & 8 deletions builtins/core/lists/push_pop_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
- a
- count
- runtime
- apis/lang.MarshalData
- apis/lang.UnmarshalData
- lang.MarshalData
- lang.UnmarshalData

- DocumentID: right
Title: >+
Expand Down Expand Up @@ -113,8 +113,8 @@
- a
- count
- runtime
- apis/lang.MarshalData
- apis/lang.UnmarshalData
- lang.MarshalData
- lang.UnmarshalData

- DocumentID: prefix
Title: >+
Expand Down Expand Up @@ -156,8 +156,8 @@
- a
- count
- runtime
- apis/lang.MarshalData
- apis/lang.UnmarshalData
- lang.MarshalData
- lang.UnmarshalData

- DocumentID: suffix
Title: >+
Expand Down Expand Up @@ -199,5 +199,5 @@
- a
- count
- runtime
- apis/lang.MarshalData
- apis/lang.UnmarshalData
- lang.MarshalData
- lang.UnmarshalData
4 changes: 2 additions & 2 deletions builtins/core/management/functions_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@
```
Synonyms:
Related:
- user-guide/reserved-vars
- reserved-vars
- source


Expand Down Expand Up @@ -454,6 +454,6 @@
Related:
- runtime
- fexec
- user-guide/modules
- modules


2 changes: 1 addition & 1 deletion builtins/core/management/shell_doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
Detail:
Synonyms:
Related:
- user-guide/reserved-vars
- reserved-vars



Expand Down
Loading