Skip to content

Commit a7684d1

Browse files
authored
contributing, jupyter style; author section more explicit (#6000)
* contributing, jupyter style; author section more explicit * jupyter style guide; contributing; make Authors plural
1 parent f9e0dfd commit a7684d1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/source/contributing/jupyter_style.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,8 @@ After the notebook content finishes, there should be an `## Authors` section wit
397397
to provide attribution to the people who contributed to the the general pattern should be:
398398

399399
```markdown
400+
## Authors
401+
400402
* <verb> by <author> on <date> ([repo#PR](https://link-to.pr))
401403
```
402404

@@ -413,6 +415,8 @@ adapted
413415
in order to include a link or reference to the original source:
414416

415417
```markdown
418+
## Authors
419+
416420
Adapted from Alice's [blogpost](blog.alice.com) by Bob and Carol on ...
417421
```
418422

@@ -427,6 +431,8 @@ updated
427431
some examples:
428432

429433
```markdown
434+
## Authors
435+
430436
* Authored by Chris Fonnesbeck in May, 2017 ([pymc#2124](https://github.com/pymc-devs/pymc/pull/2124))
431437
* Updated by Colin Carroll in June, 2018 ([pymc#3049](https://github.com/pymc-devs/pymc/pull/3049))
432438
* Updated by Alex Andorra in January, 2020 ([pymc#3765](https://github.com/pymc-devs/pymc/pull/3765))
@@ -437,6 +443,8 @@ some examples:
437443
and
438444

439445
```markdown
446+
## Authors
447+
440448
* Adapted from chapter 5 of Bayesian Data Analysis 3rd Edition {cite:p}`gelman2013bayesian`
441449
by Demetri Pananos and Junpeng Lao on June, 2018 ([pymc#3054](https://github.com/pymc-devs/pymc/pull/3054))
442450
* Reexecuted by Ravin Kumar with PyMC 3.6 on March, 2019 ([pymc#3397](https://github.com/pymc-devs/pymc/pull/3397))

0 commit comments

Comments
 (0)