Skip to content

Commit 98d4b6b

Browse files
authored
Merge pull request #57 from UiO-IN3110/dokken/header_consistency
Consistent header decrease
2 parents 2ce4fa3 + bf2b09b commit 98d4b6b

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

lectures/python/packages_and_testing.ipynb

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -668,12 +668,12 @@
668668
"id": "13ff5249",
669669
"metadata": {},
670670
"source": [
671-
"### Package name\n",
671+
"## Package name\n",
672672
"\n",
673673
"As seen in the file above, we observe that we do not need to specify alot in the project description.\n",
674674
"We give the package a name, which should be reflected in `/src/pkg`. We use the source layout as it avoids some issues with a flat package structure, see [Python packaging guide](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/) for more details.\n",
675675
"\n",
676-
"### Author list\n",
676+
"## Author list\n",
677677
"\n",
678678
"We create a list of authors with their name and email.\n"
679679
]
@@ -692,7 +692,7 @@
692692
"id": "127f9e41",
693693
"metadata": {},
694694
"source": [
695-
"### README\n",
695+
"## README\n",
696696
"\n",
697697
"A package should have a description. This should be placed in a README file. The string should contain the local path (relative to the `pyproject.toml` file) to the description file.\n"
698698
]
@@ -717,8 +717,13 @@
717717
"cell_type": "markdown",
718718
"id": "96749323",
719719
"metadata": {},
720+
"source": []
721+
},
722+
{
723+
"cell_type": "markdown",
724+
"metadata": {},
720725
"source": [
721-
"### Version\n",
726+
"## Version\n",
722727
"\n",
723728
"Given a version number `MAJOR.MINOR.PATCH`, increment the:\n",
724729
"\n",
@@ -734,7 +739,7 @@
734739
"id": "5676816a",
735740
"metadata": {},
736741
"source": [
737-
"### Python versioning\n",
742+
"## Python versioning\n",
738743
"\n",
739744
"As Python evolves and introduces new features and deprecates versions, your software should do the same. Decide on a minimal requirement for Python (and in some cases a maximum version if a package you are using is not supporting the latest Python version).\n"
740745
]
@@ -744,7 +749,7 @@
744749
"id": "79ce5039",
745750
"metadata": {},
746751
"source": [
747-
"### Dependencies\n",
752+
"## Dependencies\n",
748753
"\n",
749754
"As our package might depend on external software, we create a list of packages such as `[\"numpy>=1.21\", \"sklearn==1.3.0\"]` etc.\n",
750755
"These will be installed if not found on the system at the time of installation.\n"
@@ -755,7 +760,7 @@
755760
"id": "c1046053",
756761
"metadata": {},
757762
"source": [
758-
"### Optional dependencies\n",
763+
"## Optional dependencies\n",
759764
"\n",
760765
"Sometimes, we require dependencies for testing or development that are not requirements of the source code. We call these optional dependencies and list them as below\n"
761766
]
@@ -896,7 +901,7 @@
896901
"name": "python",
897902
"nbconvert_exporter": "python",
898903
"pygments_lexer": "ipython3",
899-
"version": "3.10.13"
904+
"version": "3.8.10"
900905
},
901906
"widgets": {
902907
"application/vnd.jupyter.widget-state+json": {

0 commit comments

Comments
 (0)