search

pymc-devs / pymc-examples

Examples of PyMC models, including a library of Jupyter notebooks.
https://www.pymc.io/projects/examples/en/latest/
MIT License
269 stars 234 forks source link

Discuss: whether to add notebook update on when notebooks were transferred from pymc #446

Open reshamas opened 1 year ago

reshamas commented 1 year ago

Notebook title: generally, most Notebook url: generally, most

Issue description

In updating the notebooks and the "Author" section, I have been adding this information:

## Authors
* Moved from pymc to pymc-examples repo in December 2020 ([pymc-examples#8](https://github.com/pymc-devs/pymc-examples/pull/8))

Some notebooks have been merged with this updates, and other(s) are under discussion. See: https://github.com/pymc-devs/pymc-examples/pull/426/files#r984794260

@OriolAbril

I would not include this here

@reshamas:

Are you sure we should remove this? I've added it in for other notebooks. I think it helps folks know that to look for prior commits on the notebook, they can find some history in the other repo.

Note

Can we discuss and agree on a consistent rule?

fonnesbeck commented 1 year ago

I don't think most will be interested in the historical location of notebooks. I would remove them. Historical commits should not be of much interest where notebooks are concerned.

OriolAbril commented 1 year ago

I also think we should not list that. Content on the website should be focused on readers/visitors. Authorship is only useful to them if they want to cite the notebook (which is why we eventually agreed to have the section at the end and not listing authors at the top nor in the right sidebar next to the tags) and to make sure we give credit to everyone who contributes. I think the fact that the notebook was moved from pymc to pymc-examples repo is not relevant to either case.

The examples in https://docs.pymc.io/en/latest/contributing/jupyter_style.html#authorship-and-attribution are also data points against this. We use the pymc#PRNUMBER or pymc-examples#PRNUMBER formatting when linking to the relevant PRs and both examples list PRs in the two repos, but neither mentions the move from one repo to another.