Skip to content

[GenerateDocCReference] Improve filtering and categorization of arguments in documentation with sectionTitle #753

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 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
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,25 @@
color --fav=<fav> [--second=<second>] [--help]
```

**--fav=\<fav\>:**
## Flags

*Your favorite color.*
**`--help`**

*Show help information.*

**--second=\<second\>:**

*Your second favorite color.*
## Options

This is optional.
**`--fav=\<fav\>`**

*Your favorite color.*

**--help:**

*Show help information.*
**`--second=\<second\>`**

*Your second favorite color.*

This is optional.


## color.help
Expand All @@ -31,9 +35,6 @@ Show subcommand help information.
color help [<subcommands>...]
```

**subcommands:**




## Arguments

**`subcommands`**
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,32 @@
count-lines [<input-file>] [--prefix=<prefix>] [--verbose] [--help]
```

**input-file:**

*A file to count lines in. If omitted, counts the lines of stdin.*
## Arguments

**`input-file`**

**--prefix=\<prefix\>:**
*A file to count lines in. If omitted, counts the lines of stdin.*

*Only count lines with this prefix.*

## Flags

**--verbose:**
**`--verbose`**

*Include extra information in the output.*


**--help:**
**`--help`**

*Show help information.*


## Options

**`--prefix=\<prefix\>`**

*Only count lines with this prefix.*


## count-lines.help

Show subcommand help information.
Expand All @@ -34,9 +40,6 @@ Show subcommand help information.
count-lines help [<subcommands>...]
```

**subcommands:**




## Arguments

**`subcommands`**
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ A utility for performing maths.
math [--version] [--help]
```

**--version:**
## Flags

**`--version`**

*Show the version.*


**--help:**
**`--help`**

*Show help information.*

Expand All @@ -26,27 +28,28 @@ Print the sum of the values.
math add [--hex-output] [<values>...] [--version] [--help]
```

**--hex-output:**

*Use hexadecimal notation for the result.*

## Arguments

**values:**
**`values`**

*A group of integers to operate on.*


**--version:**
## Flags

*Show the version.*
**`--hex-output`**

*Use hexadecimal notation for the result.*

**--help:**

*Show help information.*
**`--version`**

*Show the version.*


**`--help`**

*Show help information.*

## math.multiply

Expand All @@ -56,27 +59,28 @@ Print the product of the values.
math multiply [--hex-output] [<values>...] [--version] [--help]
```

**--hex-output:**

*Use hexadecimal notation for the result.*

## Arguments

**values:**
**`values`**

*A group of integers to operate on.*


**--version:**
## Flags

*Show the version.*
**`--hex-output`**

*Use hexadecimal notation for the result.*

**--help:**

*Show help information.*
**`--version`**

*Show the version.*


**`--help`**

*Show help information.*

## math.stats

Expand All @@ -86,12 +90,14 @@ Calculate descriptive statistics.
math stats [--version] [--help]
```

**--version:**
## Flags

**`--version`**

*Show the version.*


**--help:**
**`--help`**

*Show help information.*

Expand All @@ -104,27 +110,30 @@ Print the average of the values.
math stats average [--kind=<kind>] [<values>...] [--version] [--help]
```

**--kind=\<kind\>:**

*The kind of average to provide.*
## Arguments


**values:**
**`values`**

*A group of floating-point values to operate on.*


**--version:**
## Flags

**`--version`**

*Show the version.*


**--help:**
**`--help`**

*Show help information.*


## Options

**`--kind=\<kind\>`**

*The kind of average to provide.*

### math.stats.stdev

Expand All @@ -134,23 +143,24 @@ Print the standard deviation of the values.
math stats stdev [<values>...] [--version] [--help]
```

**values:**
## Arguments

**`values`**

*A group of floating-point values to operate on.*


**--version:**
## Flags

**`--version`**

*Show the version.*


**--help:**
**`--help`**

*Show help information.*




### math.stats.quantiles

Print the quantiles of the values (TBD).
Expand All @@ -159,42 +169,43 @@ Print the quantiles of the values (TBD).
math stats quantiles [<one-of-four>] [<custom-arg>] [<values>...] [--file=<file>] [--directory=<directory>] [--shell=<shell>] [--custom=<custom>] [--version] [--help]
```

**one-of-four:**
## Arguments

**`one-of-four`**

**custom-arg:**

**`custom-arg`**

**values:**

*A group of floating-point values to operate on.*

**`values`**

**--file=\<file\>:**

*A group of floating-point values to operate on.*

**--directory=\<directory\>:**

## Flags

**--shell=\<shell\>:**
**`--version`**

*Show the version.*

**--custom=\<custom\>:**

**`--help`**

**--version:**
*Show help information.*

*Show the version.*

## Options

**--help:**
**`--file=\<file\>`**

*Show help information.*

**`--directory=\<directory\>`**


**`--shell=\<shell\>`**


**`--custom=\<custom\>`**

## math.help

Expand All @@ -204,9 +215,6 @@ Show subcommand help information.
math help [<subcommands>...]
```

**subcommands:**




## Arguments

**`subcommands`**
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,30 @@
repeat [--count=<count>] [--include-counter] <phrase> [--help]
```

**--count=\<count\>:**
## Arguments

**`phrase`**

*The phrase to repeat.*

*The number of times to repeat 'phrase'.*

## Flags

**--include-counter:**
**`--include-counter`**

*Include a counter with each repetition.*


**phrase:**
**`--help`**

*The phrase to repeat.*
*Show help information.*


**--help:**
## Options

*Show help information.*
**`--count=\<count\>`**

*The number of times to repeat 'phrase'.*


## repeat.help
Expand All @@ -34,9 +40,6 @@ Show subcommand help information.
repeat help [<subcommands>...]
```

**subcommands:**




## Arguments

**`subcommands`**
Loading