Skip to content

Commit a4cbc2f

Browse files
sourishkroutsourishkrout
committed
Document ingore/transform cell annotations
1 parent 1342a37 commit a4cbc2f

File tree

2 files changed

+17
-27
lines changed

2 files changed

+17
-27
lines changed

‎.vscode/tasks.json‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,4 @@
11
{
22
"version": "2.0.0",
3-
"tasks": [
4-
{
5-
"type": "runme",
6-
"fileUri": "",
7-
"command": "start",
8-
"problemMatcher": [],
9-
"label": "README.md: start",
10-
"group": {
11-
"kind": "build",
12-
"isDefault": true
13-
}
14-
}
15-
]
3+
"tasks": []
164
}

‎docs/configuration/cell-level.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,22 @@ This action will run your command and return an executed output, you can configu
2727

2828
Cell level options gives users the flexibility to modify the behavior of each executable cell.
2929

30-
| Configuration | Description | Default value |
31-
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
32-
| background | Indicates if the cell should be runned as a background process | false |
33-
| closeTerminalOnSuccess | Hide Terminal after cell successful execution | true |
34-
| tag / category | Execute code cells matching a tag or category (deprecated) | [empty] |
35-
| cwd | Modify current working directory for cell execution | [empty] |
36-
| excludeFromRunAll | Prevent executing this cell during the "Run All" operation | false |
37-
| interactive | Indicates if run should allow interactive input | false |
38-
| interpreter | The program or command line inserted into shebang (aka #!) line | inferred from languageId |
39-
| mimetype | If set skips auto-detection and uses specific media (MIME) type | [empty] |
40-
| name | Cell’s canonical name useful for referencing the cell via CLI | auto-generated |
41-
| terminalRows | Number of rows to display in the notebook terminal | auto-set |
42-
| promptEnv | Prompt user to set exported environment vars | auto |
43-
| skipPrompts | Bypasses interactive [prompts](/configuration/cell-level) that require inputting environment vars or authentication confirmations. | false |
30+
| Configuration | Description | Default value |
31+
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
32+
| background | Indicates if the cell should be runned as a background process | false |
33+
| closeTerminalOnSuccess | Hide Terminal after cell successful execution | true |
34+
| tag / category | Execute code cells matching a tag or category (deprecated) | [empty] |
35+
| cwd | Modify current working directory for cell execution | [empty] |
36+
| excludeFromRunAll | Prevent executing this cell during the "Run All" operation | false |
37+
| interactive | Indicates if run should allow interactive input | false |
38+
| interpreter | The program or command line inserted into shebang (aka #!) line | [inferred from languageId] |
39+
| mimetype | If set skips auto-detection and uses specific media (MIME) type | [empty] |
40+
| name | Cell’s canonical name useful for referencing the cell via CLI | [auto-generated] |
41+
| ignore | Ingore code block from CLI and notebook transformation into a runnable cell | false |
42+
| transform | Transform code block from CLI and notebook transformation into a runnable cell (inverse of ignore; most relevant for `mermaid`) | true |
43+
| terminalRows | Number of rows to display in the notebook terminal | [auto-set] |
44+
| promptEnv | Prompt user to set exported environment vars | auto |
45+
| skipPrompts | Bypasses interactive [prompts](/configuration/cell-level) that require inputting environment vars or authentication confirmations. | false |
4446

4547
<Infobox type="sidenote" title="SkipPrompts">
4648

0 commit comments

Comments
 (0)