Skip to content

Commit

Permalink
feat: Template.WhileLoop.py ( Fixes #936 )
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Feb 17, 2024
1 parent 8c3ba2e commit d73f4e3
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/Template.WhileLoop.py.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Template.WhileLoop.py
---------------------

### Synopsis
Template for a Python `while` Loop

---

### Description

Template for a `while` loop in Python.

---

### Examples
> EXAMPLE 1
```PowerShell
Template.WhileLoop.py -Condition "false" -Body 'print("This never happens")'
```

---

### Parameters
#### **Condition**
The Loop's Condition.
This determines if the loop should continue running.

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|false |1 |true (ByPropertyName)|

#### **Body**
The body of the loop

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|false |2 |true (ByPropertyName)|

#### **BodyIndent**
The number of spaces to indent the body.
By default, two.

|Type |Required|Position|PipelineInput |
|---------|--------|--------|---------------------|
|`[Int32]`|false |3 |true (ByPropertyName)|

#### **Indent**
The number of spaces to indent all code.
By default, zero

|Type |Required|Position|PipelineInput |
|---------|--------|--------|---------------------|
|`[Int32]`|false |4 |true (ByPropertyName)|

---

### Syntax
```PowerShell
Template.WhileLoop.py [[-Condition] <String>] [[-Body] <String>] [[-BodyIndent] <Int32>] [[-Indent] <Int32>] [<CommonParameters>]
```

0 comments on commit d73f4e3

Please sign in to comment.