Auto-generate markdown command docs (#4451)

* Finish updating

* a couple improvements

* Update renames

* cleanup examples
This commit is contained in:
JT
2022-02-13 21:22:51 -05:00
committed by GitHub
parent 06f5affc0b
commit 8c0a2d3c15
478 changed files with 7676 additions and 8045 deletions

View File

@ -1,32 +1,18 @@
# do
Runs a block, optionally ignoring errors.
---
title: do
layout: command
version: 0.59.0
---
## Usage
```shell
> do <block> ...args {flags}
```
Run a block
## Signature
```> do (block) ...rest --ignore-errors```
## Parameters
* `<block>` the block to run
* ...args: the parameter(s) for the block
## Flags
* -h, --help: Display this help message
* -i, --ignore-errors: ignore errors as the block runs
## Examples
Run the block
```shell
> do { echo hello }
```
Run the block and ignore errors
```shell
> do -i { thisisnotarealcommand }
```
Run the block with a parameter
```shell
> do { |x| $x + 100 } 55
```
- `block`: the block to run
- `...rest`: the parameter(s) for the block
- `--ignore-errors`: ignore errors as the block runs