Merge branch 'main' of github.com:cu-comptools/fall2025

Author: fruzsinaagocs

github.ipynb

@@ -28,9 +28,16 @@
     "This [book on git](https://git-scm.com/book/en/v2/Getting-Started-The-Command-Line) serves as a complete reference for the system and is an excellent source of information with many examples.\n",
     "\n",
     "```{admonition} Exercise\n",
-    "Create an account on GitHub. \n",
-    "It is strongly recommended that you use the command line interface, so if you're using Windows, please make sure you have access to a unix-based terminal, via e.g. the [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about), or [Cygwin](https://www.cygwin.com), or the Windows Terminal, or Git Bash, etc.\n",
-    "Then share your username with the instructor so you can be added to our GitHub classroom.\n",
+    "1. Create an account on GitHub.\n",
+    "2. It is strongly recommended that you use the command line interface, so if you're using Windows, please make sure you have access to a unix-based terminal, via e.g. the [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about), or [Cygwin](https://www.cygwin.com), or the Windows Terminal, or Git Bash, etc. To install it,\n",
+    "```bash \n",
+    "sudo apt-get install git\n",
+    "```\n",
+    "on Linux, or\n",
+    "```bash\n",
+    "brew install git\n",
+    "```\n",
+    "on MacOS.\n",
     "```\n",
     "\n",
     "### 2.1.1 Repositories, cloning and forking\n",
@@ -95,7 +102,7 @@
     "\n",
     "```{admonition} \n",
     ":class: warning\n",
-    "Avoid storing binary files on GitHub, as even incremental changes to these result in large commits and you'll run out of your storage/bandwidth quota.\n",
+    "Avoid storing binary files (e.g *.pdf, *.o) on GitHub, as even incremental changes to these result in large commits and you'll run out of your storage/bandwidth quota.\n",
     "```\n",
     "\n",
     "It is good practice to add an **informative** commit message so that future you can understand what changes were made in a commit. \n",
@@ -119,7 +126,7 @@
     "2. Examples\n",
     "3. API- (application programmer's interface) level documentation\n",
     "\n",
-    "In-line comments may be enough for yourself to understand code that you wrote a few months back, but is insufficient in general. A much better practice is to write a _docstring_, a short description for each function, which has the following general structure (regardless of programming language, though shown in Python):\n",
+    "In-line comments may be enough for yourself to understand code that you wrote a few months back, and they are useful, but insufficient on their own. A much better practice is to write a _docstring_, a short description for each function, which has the following general structure (regardless of programming language, though shown in Python):\n",
     "\n",
     "- A short description of the function,\n",
     "- Input parameters with types and a brief description (e.g. any restrictions, default values, physical/mathematical meaning),\n",
@@ -156,7 +163,7 @@
    "id": "75a3eb2a",
    "metadata": {},
    "source": [
-    "If you write docstrings in the above format (which is called the NumPy format), or a different standardized format such as the Google format, it can be converted to API documentation automatically. For example, [this C++/Python software package](https://oscode.readthedocs.io/en/latest/) has API documentation that was auto-generated from docstrings. Docstrings may contain math formulae, or more complicated examples, see e.g the SciPy documentation."
+    "If you write docstrings in the above format (which is called the NumPy format), or a different standardized format such as the Google format, it can be converted to API documentation automatically. For example, [this C++/Python software package](https://oscode.readthedocs.io/en/latest/) has API documentation that was auto-generated from docstrings. Docstrings may contain math formulae, or more complicated examples, see e.g the [SciPy documentation](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html) (click on \"source\" near the name of the function the link leads you to and you'll see that it was all generated from a docstring)."
    ]
   },
   {
@@ -176,22 +183,16 @@
   },
   {
    "cell_type": "markdown",
-   "id": "f2befda8",
+   "id": "e942dc2f-9e2d-4a79-8e1c-63adf3f13a67",
    "metadata": {},
    "source": [
     "```{admonition} Exercises\n",
     ":class: danger\n",
-    "For exercises on writing docstrings and unit tests, please see the [Git and GitHub tutorial repository](https://github.com/cu-comptools/git-tutorial-2025).\n",
+    "1. For this exercise, you'll need to clone the repository at `https://github.com/cu-comptools/gh-tutorial`.\n",
+    "\n",
+    "\n",
     "```"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "bebd8bfe",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -210,7 +211,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.16"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,