From 8747dd9af78cccf6e7a21787cb282998a2ac47df Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Mon, 2 Oct 2023 17:30:45 +0530 Subject: [PATCH 1/8] fix: Broken link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6aa6987c2..84d7ec8c3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -185,7 +185,7 @@ You may also test multiple notebooks this way. Passing the path to a folder will nox -s examples -- docs/source/examples/notebooks/models/ ``` -You may also use an appropriate [glob pattern](https://www.malikbrowne.com/blog/a-beginners-guide-glob-patterns) to run all notebooks matching a particular folder or name pattern. +You may also use an appropriate [glob pattern](https://developers.tetrascience.com/docs/common-glob-pattern) to run all notebooks matching a particular folder or name pattern. To edit the structure and how the Jupyter notebooks get rendered in the Sphinx documentation (using `nbsphinx`), install [Pandoc](https://pandoc.org/installing.html) on your system, either using `conda` (through the `conda-forge` channel) From cbec0e946f51f0d342d5e31f2fd5e2b7aa1e7bb8 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Mon, 2 Oct 2023 17:41:17 +0530 Subject: [PATCH 2/8] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21cfb2ae87..809a721e2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ## Bug fixes +- Fixed a bug where there was an expired link related to glob pattern in the CONTRIBUTING.md file.([#3393](https://github.com/pybamm-team/PyBaMM/pull/3393)) - Fixed a bug where empty lists passed to QuickPlot resulted in an IndexError and did not return a meaningful error message ([#3359](https://github.com/pybamm-team/PyBaMM/pull/3359)) - Fixed a bug where there was a missing thermal conductivity in the thermal pouch cell models ([#3330](https://github.com/pybamm-team/PyBaMM/pull/3330)) - Fixed a bug that caused incorrect results of “{Domain} electrode thickness change [m]” due to the absence of dimension for the variable `electrode_thickness_change`([#3329](https://github.com/pybamm-team/PyBaMM/pull/3329)). From 3ebb05ff985bdf503bb8038c7705758372d9c3d9 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Mon, 2 Oct 2023 18:02:26 +0530 Subject: [PATCH 3/8] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 809a721e2f..21cfb2ae87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,6 @@ ## Bug fixes -- Fixed a bug where there was an expired link related to glob pattern in the CONTRIBUTING.md file.([#3393](https://github.com/pybamm-team/PyBaMM/pull/3393)) - Fixed a bug where empty lists passed to QuickPlot resulted in an IndexError and did not return a meaningful error message ([#3359](https://github.com/pybamm-team/PyBaMM/pull/3359)) - Fixed a bug where there was a missing thermal conductivity in the thermal pouch cell models ([#3330](https://github.com/pybamm-team/PyBaMM/pull/3330)) - Fixed a bug that caused incorrect results of “{Domain} electrode thickness change [m]” due to the absence of dimension for the variable `electrode_thickness_change`([#3329](https://github.com/pybamm-team/PyBaMM/pull/3329)). From 278bdf4d301aed69bb8a11b7f20079d6215e1695 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Mon, 2 Oct 2023 19:22:24 +0530 Subject: [PATCH 4/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84d7ec8c3e..98d48b6f4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -185,7 +185,7 @@ You may also test multiple notebooks this way. Passing the path to a folder will nox -s examples -- docs/source/examples/notebooks/models/ ``` -You may also use an appropriate [glob pattern](https://developers.tetrascience.com/docs/common-glob-pattern) to run all notebooks matching a particular folder or name pattern. +You may also use an appropriate [glob pattern](https://linux.die.net/man/7/glob) to run all notebooks matching a particular folder or name pattern. To edit the structure and how the Jupyter notebooks get rendered in the Sphinx documentation (using `nbsphinx`), install [Pandoc](https://pandoc.org/installing.html) on your system, either using `conda` (through the `conda-forge` channel) From cf4ead658c556b3532faf425f91f35a58170b2b0 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Mon, 2 Oct 2023 20:29:27 +0530 Subject: [PATCH 5/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98d48b6f4a..4612e83252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -185,7 +185,7 @@ You may also test multiple notebooks this way. Passing the path to a folder will nox -s examples -- docs/source/examples/notebooks/models/ ``` -You may also use an appropriate [glob pattern](https://linux.die.net/man/7/glob) to run all notebooks matching a particular folder or name pattern. +You may also use an appropriate [glob pattern](https://docs.python.org/3/library/glob.html) to run all notebooks matching a particular folder or name pattern. To edit the structure and how the Jupyter notebooks get rendered in the Sphinx documentation (using `nbsphinx`), install [Pandoc](https://pandoc.org/installing.html) on your system, either using `conda` (through the `conda-forge` channel) From 96eef72344451e532636167eafa3ef279149e7aa Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Sun, 8 Oct 2023 17:51:37 +0530 Subject: [PATCH 6/8] Fix URL --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4bb69ac7c..9f45d34327 100644 --- a/README.md +++ b/README.md @@ -233,7 +233,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Chuck Liu
Chuck Liu
🐛 💻 partben
partben
📖 - Gavin Wiggins
Gavin Wiggins
🐛 💻 + Gavin Wiggins
Gavin Wiggins
🐛 💻 Dion Wilde
Dion Wilde
🐛 💻 Elias Hohl
Elias Hohl
💻 KAschad
KAschad
🐛 From f5ddab39fb673d0ffb297d49e4c4f6e5f42d65e8 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Sun, 8 Oct 2023 17:52:10 +0530 Subject: [PATCH 7/8] Update .all-contributorsrc --- .all-contributorsrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 2456085b32..405ff36569 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -442,7 +442,7 @@ "login": "wigging", "name": "Gavin Wiggins", "avatar_url": "https://avatars.githubusercontent.com/u/6828967?v=4", - "profile": "https://wigging.me", + "profile": "https://gavinw.me", "contributions": [ "bug", "code" From bc909c3212f0b7d7974b6e11525b1f7108b37489 Mon Sep 17 00:00:00 2001 From: Agnik Bakshi <77234005+Agnik7@users.noreply.github.com> Date: Sun, 8 Oct 2023 18:08:48 +0530 Subject: [PATCH 8/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4612e83252..bec0fee02a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ You now have everything you need to start making changes! ### B. Writing your code -6. PyBaMM is developed in [Python](https://en.wikipedia.org/wiki/Python_(programming_language)), and makes heavy use of [NumPy](https://en.wikipedia.org/wiki/NumPy) (see also [NumPy for MatLab users](https://numpy.org/doc/stable/user/numpy-for-matlab-users.html) and [Python for R users](http://blog.hackerearth.com/how-can-r-users-learn-python-for-data-science)). +6. PyBaMM is developed in [Python](https://en.wikipedia.org/wiki/Python_(programming_language)), and makes heavy use of [NumPy](https://en.wikipedia.org/wiki/NumPy) (see also [NumPy for MatLab users](https://numpy.org/doc/stable/user/numpy-for-matlab-users.html) and [Python for R users](https://www.rebeccabarter.com/blog/2023-09-11-from_r_to_python)). 7. Make sure to follow our [coding style guidelines](#coding-style-guidelines). 8. Commit your changes to your branch with [useful, descriptive commit messages](https://chris.beams.io/posts/git-commit/): Remember these are publicly visible and should still make sense a few months ahead in time. While developing, you can keep using the GitHub issue you're working on as a place for discussion. [Refer to your commits](https://stackoverflow.com/questions/8910271/how-can-i-reference-a-commit-in-an-issue-comment-on-github) when discussing specific lines of code. 9. If you want to add a dependency on another library, or re-use code you found somewhere else, have a look at [these guidelines](#dependencies-and-reusing-code).