Skip to content

Commit fab2b66

Browse files
committed
extra tweaks
1 parent 87294c1 commit fab2b66

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/source/contributing/jupyter_style.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the repository where the notebook is in (pymc or pymc-examples).
3131
Choosing variable names can sometimes be difficult, tedious or annoying.
3232
In case it helps, the dropdown below has some suggestions so you can focus on writing the actual content
3333

34-
::::::{dropdown} Variable name suggestions
34+
:::::::{dropdown} Variable name suggestions
3535
:icon: light-bulb
3636

3737
**Models and sampling results**
@@ -76,7 +76,8 @@ In case it helps, the dropdown below has some suggestions so you can focus on wr
7676

7777
::::{tab-set}
7878
:::{tab-item} Local `ax` variables
79-
```
79+
```{code-block} python
80+
:emphasize-lines: 3, 7
8081
fig, axs = pyplot.subplots()
8182
8283
ax = axs[0, 1]
@@ -126,7 +127,8 @@ In case it helps, the dropdown below has some suggestions so you can focus on wr
126127
* When looping, if you need to store a variable after subsetting with the loop index,
127128
append the index variable used for looping to the original variable name:
128129

129-
```
130+
```{code-block} python
131+
:emphasize-lines: 4, 6
130132
variable = np.array(...)
131133
x = np.array(...)
132134
for i in range(N):
@@ -136,7 +138,7 @@ In case it helps, the dropdown below has some suggestions so you can focus on wr
136138
...
137139
```
138140

139-
::::::
141+
:::::::
140142

141143
## First cell
142144
The first cell of all example notebooks should have a MyST target, a level 1 markdown title (that is a title with a single `#`) followed by the post directive.
@@ -437,12 +439,14 @@ Once you're finished with your NB, add a very last cell with [the watermark pack
437439

438440
```python
439441
%load_ext watermark
440-
%watermark -n -u -v -iv -w -p theano,xarray
442+
%watermark -n -u -v -iv -w -p aesara,xarray
441443
```
442444

443445
This second to last code cell should be preceded by a markdown cell with the `## Watermark` title only so it appears in the table of contents.
444446

445-
`watermark` should be in your virtual environment if you installed our `requirements-dev.txt`. Otherwise, just run `pip install watermark`. The `p` flag is optional but should be added if Theano (or Aesara if in `v4`) or xarray are not imported explicitly.
447+
`watermark` should be in your virtual environment if you installed our `requirements-dev.txt`.
448+
Otherwise, just run `pip install watermark`.
449+
The `p` flag is optional but should be added if Aesara or xarray are not imported explicitly.
446450
This will also be checked by `pre-commit` (because we all forget to do things sometimes 😳).
447451

448452
## Epilogue

0 commit comments

Comments
 (0)