You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/contributing/jupyter_style.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,7 @@ np.array(
112
112
After the notebook content finishes, there should be an `## Authors` section with bullet points
113
113
to provide attribution to the people who contributed to the the general pattern should be:
114
114
115
-
```
115
+
```markdown
116
116
* <verb> by <author> on <date> ([repo#PR](https://link-to.pr))
117
117
```
118
118
@@ -127,7 +127,7 @@ adapted
127
127
It will therefore follow a different structure than the example above
128
128
in order to include a link or reference to the original source:
129
129
130
-
```
130
+
```markdown
131
131
Adapted from Alice's [blogpost](blog.alice.com) by Bob and Carol on ...
132
132
```
133
133
re-executed
@@ -139,7 +139,7 @@ updated
139
139
140
140
some examples:
141
141
142
-
```
142
+
```markdown
143
143
* Authored by Chris Fonnesbeck in May, 2017 ([pymc#2124](https://github.com/pymc-devs/pymc/pull/2124))
144
144
* Updated by Colin Carroll in June, 2018 ([pymc#3049](https://github.com/pymc-devs/pymc/pull/3049))
145
145
* Updated by Alex Andorra in January, 2020 ([pymc#3765](https://github.com/pymc-devs/pymc/pull/3765))
@@ -149,8 +149,8 @@ some examples:
149
149
150
150
and
151
151
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`
154
154
by Demetri Pananos and Junpeng Lao on June, 2018 ([pymc#3054](https://github.com/pymc-devs/pymc/pull/3054))
155
155
* Reexecuted by Ravin Kumar with PyMC 3.6 on March, 2019 ([pymc#3397](https://github.com/pymc-devs/pymc/pull/3397))
156
156
* 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
200
200
%watermark -n -u -v -iv -w -p theano,xarray
201
201
```
202
202
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.
204
204
205
205
`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.
206
206
This will also be checked by `pre-commit` (because we all forget to do things sometimes 😳).
0 commit comments