Skip to content

Commit 93b5ef1

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating PipeScript.HelpOut.ps1 - auto-documenting Transpilers (#56)
1 parent 7dc2eb4 commit 93b5ef1

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/Explicit-Transpiler.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
Transpilers/Explicit.psx.ps1
3+
----------------------------
4+
### Synopsis
5+
Makes Output from a PowerShell function Explicit.
6+
7+
---
8+
### Description
9+
10+
Makes a PowerShell function explicitly output.
11+
12+
All statements will be assigned to $null, unless they explicitly use Write-Output or echo.
13+
14+
If Write-Output or echo is used, the command will be replaced for more effecient output.
15+
16+
---
17+
### Parameters
18+
#### **ScriptBlock**
19+
20+
|Type |Requried|Postion|PipelineInput |
21+
|-------------------|--------|-------|--------------|
22+
|```[ScriptBlock]```|true |1 |true (ByValue)|
23+
---
24+
### Outputs
25+
System.Collections.IDictionary
26+
27+
28+
---
29+
### Syntax
30+
```PowerShell
31+
Transpilers/Explicit.psx.ps1 [-ScriptBlock] <ScriptBlock> [<CommonParameters>]
32+
```
33+
---
34+
35+

0 commit comments

Comments
 (0)