Skip to content

Commit 8476e53

Browse files
authored
Apply suggestions from code review
1 parent 28d1701 commit 8476e53

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/source/contributing/jupyter_style.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ np.array(
112112
After the notebook content finishes, there should be an `## Authors` section with bullet points
113113
to provide attribution to the people who contributed to the the general pattern should be:
114114

115-
```
115+
```markdown
116116
* <verb> by <author> on <date> ([repo#PR](https://link-to.pr))
117117
```
118118

@@ -127,7 +127,7 @@ adapted
127127
It will therefore follow a different structure than the example above
128128
in order to include a link or reference to the original source:
129129

130-
```
130+
```markdown
131131
Adapted from Alice's [blogpost](blog.alice.com) by Bob and Carol on ...
132132
```
133133
re-executed
@@ -139,7 +139,7 @@ updated
139139

140140
some examples:
141141

142-
```
142+
```markdown
143143
* Authored by Chris Fonnesbeck in May, 2017 ([pymc#2124](https://github.com/pymc-devs/pymc/pull/2124))
144144
* Updated by Colin Carroll in June, 2018 ([pymc#3049](https://github.com/pymc-devs/pymc/pull/3049))
145145
* Updated by Alex Andorra in January, 2020 ([pymc#3765](https://github.com/pymc-devs/pymc/pull/3765))
@@ -149,8 +149,8 @@ some examples:
149149

150150
and
151151

152-
```
153-
* Adapted from chapter 5 of Bayesian Data Analysis 3rd Edition {cite:p}gelman2013bayesian
152+
```markdown
153+
* Adapted from chapter 5 of Bayesian Data Analysis 3rd Edition {cite:p}`gelman2013bayesian`
154154
by Demetri Pananos and Junpeng Lao on June, 2018 ([pymc#3054](https://github.com/pymc-devs/pymc/pull/3054))
155155
* Reexecuted by Ravin Kumar with PyMC 3.6 on March, 2019 ([pymc#3397](https://github.com/pymc-devs/pymc/pull/3397))
156156
* Reexecuted by Alex Andorra and Michael Osthege with PyMC 3.9 on June, 2020 ([pymc#3955](https://github.com/pymc-devs/pymc/pull/3955))
@@ -200,7 +200,7 @@ Once you're finished with your NB, add a very last cell with [the watermark pack
200200
%watermark -n -u -v -iv -w -p theano,xarray
201201
```
202202

203-
This last code cell should be preceded by a markdown cell with the `## Watermark` title only so it appears in the table of contents.
203+
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.
204204

205205
`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.
206206
This will also be checked by `pre-commit` (because we all forget to do things sometimes 😳).

0 commit comments

Comments
 (0)