Skip to content

Commit e9dfcc9

Browse files
committed
Clarify promptEnv
1 parent 5985a5e commit e9dfcc9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/configuration/cell-level.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,12 +179,18 @@ openssl rand -base64 32
179179
180180
### Environment variables
181181
182-
If a cell has exported variables, the user will be prompted to set these variables. This can be useful to have a parameterized cell while not needing to manually modify the cell.
182+
If a cell has exported variables, the user will be prompted to set these variables. This can be useful to have a parameterized cell while not needing to manually modify the cell. Following modes are available:
183183
184-
**How to Enable PromptEnv**
184+
| Mode | Description |
185+
| -------------- | ----------------------------------------------------------------------------------------------------- |
186+
| auto [default] | Prompt when environment variable has no value (e.g. loaded from .env). |
187+
| always | Always prompt allow for environment variable. Use existing value as placeholder if present. |
188+
| never | Never prompt for any environment variables. Evaluate expression and values as is or leave them empty. |
189+
190+
**How to Set PromptEnv**
185191
186192
- Click on `configure ⚙️` in your code cell
187-
- Click `promptEnv` to set the condition you want the cell to run in
193+
- Click `promptEnv` to set the mode you want the cell to run in
188194
189195
![promptenv](/img/getting-started/promptsenv.png)
190196

0 commit comments

Comments
 (0)