first release

Author: giumas

006_Read_and_Write_Text_Files.ipynb

@@ -298,7 +298,7 @@
    "source": [
     "From the [Lists of Variables notebook](002_Lists_of_Variables.ipynb), you know how to access an item in a list by its index. \n",
     "\n",
-    "Thus, to access the file name `sal.txt`, we can use `1` as index since it is the **second** element in the list."
+    "In this particular case, to access the file name `sal.txt`, we will use `1` as index since it is the **second** element in the `retrieved_paths` list."
    ]
   },
   {
@@ -311,6 +311,15 @@
     "print(\"The file path with index 1 is: \" + sal_path)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/key.png\">\n",
+    "\n",
+    "**CAUTION**: The above solution works **specifically** with the current directory content. For instance, changing the directory content may alter the index of the salinity file in the list, thus breaking your code."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

007_Dictionaries_and_Metadata.ipynb

@@ -540,7 +540,7 @@
     "metadata = dict()\n",
     "metadata[\"first_name\"] = \"John\"\n",
     "\n",
-    "print(\"The first name is: %s\" % (metadata[\"first_name\"], ))"
+    "print(\"The first name is: %s\" % (metadata[\"first_name\"]))"
    ]
   },
   {
@@ -555,7 +555,7 @@
     "metadata[\"start_timestamp\"] = datetime(2019, 2, 22, 12, 32, 40)\n",
     "\n",
     "print(\"The position is: %s, %s\" % (metadata[\"latitude\"], metadata[\"longitude\"]))\n",
-    "print(\"Start time: %s\" % (metadata[\"start_timestamp\"], ))"
+    "print(\"Start time: %s\" % (metadata[\"start_timestamp\"]))"
    ]
   },
   {
@@ -575,7 +575,7 @@
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/info.png\">\n",
     "\n",
     "In the above code, the values inside the rounded brackets after the `%` operator create a so-called [`tuple`](https://docs.python.org/3.6/library/stdtypes.html?#tuples). <br>\n",
-    "A `tuple` is a Python container that represents an immutable sequence (thus, you cannot change the content of a `tuple`)."
+    "A `tuple` is a Python container similar to a list except that you cannot modify the content after creation (an **immutable sequence**)."
    ]
   },
   {

008_A_Class_as_a_Data_Container.ipynb

@@ -19,14 +19,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "It is time to learn how to define your own type! "
+    "You encountered several data types. Sometimes you may need a custom type. So it is time to learn how to define your own data type! "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Creating your own type is a bit more complicated than writing functions, but it comes with big advantages that will be apparent soon."
+    "Creating your own data type is a bit more complicated than writing functions, but it comes with big advantages that soon will be apparent."
    ]
   },
   {
@@ -58,21 +58,21 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "However, this notebook will only use a class as a data container. And we will learn it by example.  "
+    "This notebook will **only** use a class as a data container. And you will learn by example.  "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Class Definition and Instantiation"
+    "## Class Definition"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Assuming that we want to create a class that is able to hold the content of the `sal.txt` file cited in a [previous notebook](006_Read_and_Write_Text_Files.ipynb). As such, we will call this new class `SalinityData`."
+    "We want to create a class that is able to hold the content of the `sal.txt` file cited in a [previous notebook](006_Read_and_Write_Text_Files.ipynb). We will give this class the meaningful name of `SalinityData`."
    ]
   },
   {
@@ -96,14 +96,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The first line of the above code contains: the `class` keyword, the class name (`SalinityData`), and  a `:`."
+    "The first line of the above code contains: the `class` keyword, the class name (`SalinityData`), and  a `:`"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The second line is a special text, called `docstring`, that provides a brief description of the class. The description is between `\"\"\" \"\"\"` (i.e., triple quotes)."
+    "The second line is a special descriptive text, called `docstring`, that provides a brief explanation about the class. The description is between `\"\"\" \"\"\"` (i.e., triple quotes)."
    ]
   },
   {
@@ -119,7 +119,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Once defined, we can create an instance of the `SalinityData` class, by calling it with `()` at the end:"
+    "Once defined, we can create an object (**instance**) of the `SalinityData` class, by calling it with `()` at the end:"
    ]
   },
   {
@@ -162,14 +162,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Because the `SalinityData` class is defined in this \"main\" notebook, the full name of the type is `__main__.SalinityData`"
+    "Because the `SalinityData` class is defined in this notebook, the full name of the type is `__main__.SalinityData`. At this stage of learning Python, you can safely ignore the `__main__.` part."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "At the moment, this new defined class is not that exciting. We will soon start to populate it with a number of useful **attributes** and **methods**."
+    "At the moment, this newly defined class is not that exciting. We will soon start to populate it with a number of useful **attributes** and **methods**."
    ]
   },
   {
@@ -178,7 +178,7 @@
    "source": [
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/key.png\">\n",
     "\n",
-    "The **class attributes** are used to maintain the state of each class instance. The **class methods** may modify the attributes and thus its state."
+    "The **class attributes** are variables that capture all the information describing the class. Thus, **class attributes** maintain the **state** of each class instance. The **class methods** may modify the attributes and thus its state."
    ]
   },
   {
@@ -187,7 +187,7 @@
    "source": [
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/key.png\">\n",
     "\n",
-    "The **methods** definition **always** has `self` as first parameter. The `self` is absent in the generic **functions** that we have seen in the [Write Your Own Functions notebook](005_Write_Your_Own_Functions.ipynb)."
+    "The **class methods** definition must **always** have `self` as first parameter."
    ]
   },
   {
@@ -203,14 +203,14 @@
    "source": [
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/key.png\">\n",
     "\n",
-    "The **class initialization** happens within a special method called `__init__(self)`. "
+    "The **class initialization** is done by a special method called `__init__(self)`. "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If you don't provide a `__init__(self)` method (like in the above code), Python will create an implicit one for you."
+    "If you don't provide a `__init__(self)` method (like in the code below), Python will create one for you behind the scenes (**implicitly**)."
    ]
   },
   {
@@ -262,27 +262,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Salinity values: []\n"
-     ]
-    }
-   ],
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
    "source": [
     "sal_data = SalinityData()\n",
-    "print(\"Salinity values: %s\" % (sal_data.sal_values, ))"
+    "print(\"Salinity values: %s\" % (sal_data.sal_values))"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The above code prints that the list content is `[]`. This is not surprising since the list was created empty in the `__init__(self)` method."
+    "The above code prints the list content as `[]`. This is not surprising since an empty list was created in the `__init__(self)` method."
    ]
   },
   {
@@ -308,7 +300,7 @@
    "source": [
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/test.png\">\n",
     "\n",
-    "Write a class for a `TemperatureData` with functionalities similar to the above `SalinityData`. Then, add the code to demonstrate its functionalities."
+    "Write a `TemperatureData` class definition similar to the above `SalinityData`. Then, create an instance of that class and print the temperature values."
    ]
   },
   {
@@ -348,7 +340,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "There is much more that you can do with a class, but this is the amount of information that you need to complete this training. "
+    "There is much more that you can do with a class, but this is the amount of information that you need to complete this *Programming Basics with Python* training. "
    ]
   },
   {
@@ -357,7 +349,7 @@
    "source": [
     "<img align=\"left\" width=\"6%\" style=\"padding-right:10px;\" src=\"images/info.png\">\n",
     "\n",
-    "If you are eager to know more about classes, you may read [this supplemental notebook](SUP_First_Steps_of_a_Class.ipynb)."
+    "If you are interested in learning more about classes, you may read [this supplemental notebook](SUP_First_Steps_of_a_Class.ipynb)."
    ]
   },
   {
@@ -398,7 +390,7 @@
    "metadata": {},
    "source": [
     "<!--NAVIGATION-->\n",
-    "[< Dictionaries and Metadata](007_Dictionaries_and_Metadata.ipynb) | [Contents](index.ipynb) | [Wrapping Up Notions >](009_Wrapping_Up_Notions.ipynb)"
+    "[< Dictionaries and Metadata](007_Dictionaries_and_Metadata.ipynb) | [Contents](index.ipynb) | [Summing-Up >](009_Summing-Up.ipynb)"
    ]
   }
  ],