Skip to content

Commit 4edafcc

Browse files
StartAutomatingStartAutomating
authored andcommitted
Join-PipeScript: Improving Unnamed end block behavior (Fixes #363)
1 parent 0b6c538 commit 4edafcc

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

docs/YAML.Template.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
YAML.Template
22
-------------
3+
4+
5+
6+
37
### Synopsis
48
Yaml Template Transpiler.
59

10+
11+
612
---
13+
14+
715
### Description
816

917
Allows PipeScript to generate Yaml.
@@ -12,7 +20,11 @@ Because Yaml does not support comment blocks, PipeScript can be written inline i
1220

1321
PipeScript can be included in a multiline Yaml string with the Key PipeScript and a Value surrounded by {}
1422

23+
24+
1525
---
26+
27+
1628
### Examples
1729
#### EXAMPLE 1
1830
```PowerShell
@@ -41,82 +53,82 @@ List:
4153
}
4254

4355
.> .\HelloWorld.ps1.yaml
56+
57+
4458
---
59+
60+
4561
### Parameters
4662
#### **CommandInfo**
4763

4864
The command information. This will include the path to the file.
4965

5066

5167

52-
> **Type**: ```[CommandInfo]```
5368

54-
> **Required**: true
5569

56-
> **Position**: named
5770

58-
> **PipelineInput**:true (ByValue)
71+
|Type |Required|Position|PipelineInput |
72+
|---------------|--------|--------|--------------|
73+
|`[CommandInfo]`|true |named |true (ByValue)|
5974

6075

6176

62-
---
6377
#### **AsTemplateObject**
6478

6579
If set, will return the information required to dynamically apply this template to any text.
6680

6781

6882

69-
> **Type**: ```[Switch]```
7083

71-
> **Required**: true
7284

73-
> **Position**: named
7485

75-
> **PipelineInput**:false
86+
|Type |Required|Position|PipelineInput|
87+
|----------|--------|--------|-------------|
88+
|`[Switch]`|true |named |false |
7689

7790

7891

79-
---
8092
#### **Parameter**
8193

8294
A dictionary of parameters.
8395

8496

8597

86-
> **Type**: ```[IDictionary]```
8798

88-
> **Required**: false
8999

90-
> **Position**: named
91100

92-
> **PipelineInput**:false
101+
|Type |Required|Position|PipelineInput|
102+
|---------------|--------|--------|-------------|
103+
|`[IDictionary]`|false |named |false |
93104

94105

95106

96-
---
97107
#### **ArgumentList**
98108

99109
A list of arguments.
100110

101111

102112

103-
> **Type**: ```[PSObject[]]```
104113

105-
> **Required**: false
106114

107-
> **Position**: named
108115

109-
> **PipelineInput**:false
116+
|Type |Required|Position|PipelineInput|
117+
|--------------|--------|--------|-------------|
118+
|`[PSObject[]]`|false |named |false |
119+
120+
110121

111122

112123

113124
---
125+
126+
114127
### Syntax
115128
```PowerShell
116129
YAML.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
117130
```
118131
```PowerShell
119132
YAML.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
120133
```
121-
---
122134

0 commit comments

Comments
 (0)