Skip to content

Commit c03c4be

Browse files
authored
Merge pull request #80 from kylebutts/master
Update docs to include `# %%` code cell markers
2 parents e27ae04 + b33f228 commit c03c4be

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

docs/src/userguide/keyboard.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Below are keyboard shortcut reference for three different platforms.
1616
| `Home` | Julia: Show First Plot|
1717
| `End` | Julia: Show Last Plot|
1818
| `Shift` + `Delete` | Julia: Delete All Plots|
19-
| `Shift` + `Enter` |Julia: Execute Code Cell And Move|
19+
| `Alt` + `Enter` |Julia: Execute Code Cell|
20+
| `Alt` + `Shift` + `Enter` |Julia: Execute Code Cell And Move|
2021
| `Ctrl` + `C` | Julia: Clear Inline Results in Editor|
2122
| `Ctrl` + `D` | Julia: Clear Current Inline Result|
2223
| `Alt` + `M` | Julia: Select Current Module|
@@ -35,7 +36,8 @@ Below are keyboard shortcut reference for three different platforms.
3536
| `Home` | Julia: Show First Plot|
3637
| `End` | Julia: Show Last Plot|
3738
| `Shift` + `Delete` | Julia: Delete All Plots|
38-
| `Shift` + `Enter` |Julia: Execute Code Cell And Move|
39+
| `Option` + `Enter` |Julia: Execute Code Cell|
40+
| `Option` + `Shift` + `Enter` |Julia: Execute Code Cell And Move|
3941
| `Control` + `C` | Julia: Clear Inline Results in Editor|
4042
| `Control` + `D` | Julia: Clear Current Inline Result|
4143
| `Option` + `M` | Julia: Select Current Module|
@@ -54,7 +56,8 @@ Below are keyboard shortcut reference for three different platforms.
5456
| `Home` | Julia: Show First Plot|
5557
| `End` | Julia: Show Last Plot|
5658
| `Shift` + `Delete` | Julia: Delete All Plots|
57-
| `Shift` + `Enter` |Julia: Execute Code Cell And Move|
59+
| `Alt` + `Enter` |Julia: Execute Code Cell|
60+
| `Shift` + `Alt` + `Enter` |Julia: Execute Code Cell And Move|
5861
| `Ctrl` + `C` | Julia: Clear Inline Results in Editor|
5962
| `Ctrl` + `D` | Julia: Clear Current Inline Result|
6063
| `Alt` + `M` | Julia: Select Current Module|

docs/src/userguide/runningcode.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The REPL that is started with the `Julia: Start REPL` command will have the root
3232
There are four commands that you can use to run code from your editor in the Julia REPL:
3333

3434
- `Julia: Execute Code in REPL`
35-
- `Julia: Execute Code Cell in REPL`
35+
- `Julia: Execute Code Cell in REPL` / `Julia: Execute Code Cell in REPL and Move`
3636
- `Julia: Execute File in REPL`
3737
- `Julia: Run File in New Process`
3838

@@ -46,7 +46,9 @@ For most users, this should be their default command to run Julia code in the RE
4646

4747
### Julia: Execute Code Cell in REPL
4848

49-
The extension provides support for demarking code cells in standard Julia files with a specially formatted comment: `##`. This command will identify in which code cell the cursor in the active editor currently is and then execute the code in that cell. If there are no code cells used in the current file, it will execute the entire file.
49+
The extension provides support for demarking code cells in standard Julia files with a specially formatted comment: `##` or `# %%`. Either symbol must occur the start of a line and can be followed by text. This command will identify in which code cell the cursor in the active editor currently is and then execute the code in that cell. If there are no code cells used in the current file, it will execute the entire file.
50+
51+
Cell delimiters can be specified as regex expressions with the `julia.cellDelimiters` user setting. The default being `["^##(?!#)", "^#(\\s?)%%", "^#-"].
5052

5153
This command uses the same code execution techniques as the `Julia: Execute Code Block` command. Include statements, location information etc. all work as expected, that is run with this command.
5254

docs/src/userguide/weave.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Julia Markdown Documents
22

3-
The extension supports Weave markdown documents with the `.jmd` extension. All Julia code evaluation keybindings and commands should work normally, but cells are defined as fenced Julia code blocks instead (the usual `##` delimiter has no meaning here).
3+
The extension supports Weave markdown documents with the `.jmd` extension. All Julia code evaluation keybindings and commands should work normally, but cells are defined as fenced Julia code blocks instead (the usual `##`/`# %%` delimiters have no meaning here).
44

55
The `Julia Weave: Open Preview` command to weave the current file to a temporary HTML document, which will then be displayed in the editor. `Julia Weave: Save to File...` allows you to select the output format and will save the weaved document next to the source file.

0 commit comments

Comments
 (0)