Skip to content

contributing, jupyter style; author section more explicit #6000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2022
Merged

contributing, jupyter style; author section more explicit #6000

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e07d1e8
contributing, jupyter style; author section more explicit
reshamas Jul 22, 2022
91483f6
jupyter style guide; contributing; make Authors plural
reshamas Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/contributing/jupyter_style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,8 @@ After the notebook content finishes, there should be an `## Authors` section wit
to provide attribution to the people who contributed to the the general pattern should be:

```markdown
## Authors

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

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

```markdown
## Authors

Adapted from Alice's [blogpost](blog.alice.com) by Bob and Carol on ...
```

Expand All @@ -427,6 +431,8 @@ updated
some examples:

```markdown
## Authors

* Authored by Chris Fonnesbeck in May, 2017 ([pymc#2124](https://github.com/pymc-devs/pymc/pull/2124))
* Updated by Colin Carroll in June, 2018 ([pymc#3049](https://github.com/pymc-devs/pymc/pull/3049))
* Updated by Alex Andorra in January, 2020 ([pymc#3765](https://github.com/pymc-devs/pymc/pull/3765))
Expand All @@ -437,6 +443,8 @@ some examples:
and

```markdown
## Authors

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