Skip to content

Commit 413aad4

Browse files
committed
Format headings
1 parent 236b072 commit 413aad4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/reference/cli/function/index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,18 @@ Type: string
153153
Required: false
154154
Position: 0
155155
```
156+
156157
## Options
158+
157159
### -o, --output-format
160+
158161
<a id="-o"></a>
159162
<a id="--output-format"></a>
163+
160164
Defines the output format for the command. By default, when run in an interactive terminal, the
161165
command outputs a human-readable table. When run non-interactively or when the output is
162166
redirected, the command outputs JSON.
167+
163168
```yaml
164169
Type: string
165170
Mandatory: false
@@ -168,26 +173,35 @@ ValidValues: [json, pretty-json, yaml, table-no-truncate]
168173
LongSyntax: --output-format <FORMAT>
169174
ShortSyntax: -o <FORMAT>
170175
```
176+
171177
### -h, --help
178+
172179
<a id="-h"></a>
173180
<a id="--help"></a>
181+
174182
Displays the help for the current command. When you specify this option, the application ignores
175183
all other options and arguments.
184+
176185
```yaml
177186
Type : boolean
178187
Mandatory : false
179188
LongSyntax : --help
180189
ShortSyntax : -h
181190
```
191+
182192
## Output
193+
183194
The command returns information about DSC functions. The output includes:
195+
184196
- **name** - The name of the function
185197
- **category** - The category the function belongs to (Logical, Numeric, String, Array, System, Resource)
186198
- **description** - A description of what the function does
187199
- **minArgs** - The minimum number of arguments the function accepts
188200
- **maxArgs** - The maximum number of arguments the function accepts
189201
- **acceptedArgTypes** - The types of arguments the function accepts
202+
190203
### Argument Types
204+
191205
The `acceptedArgTypes` field uses the following abbreviations in table format:
192206

193207
- **a** - Array
@@ -198,4 +212,4 @@ The `acceptedArgTypes` field uses the following abbreviations in table format:
198212
- **-** - No specific type (any type accepted)
199213

200214
When multiple types are accepted, multiple letters are shown. For example, `sn` means the function
201-
accepts both String and Number arguments.
215+
accepts both String and Number arguments.

0 commit comments

Comments
 (0)