Skip to content

Commit 5f6e3ed

Browse files
authored
Merge pull request #560 from tobyhodges/inline-instructor-notes
Inline instructor notes
2 parents 1021a9c + 194b52a commit 5f6e3ed

4 files changed

Lines changed: 49 additions & 36 deletions

File tree

episodes/02-starting-with-data.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,16 @@ max 280.000000
478478
Name: weight, dtype: float64
479479
```
480480

481+
::::::::::::::::::::::::::::::::::::::::: instructor
482+
483+
## Important Bug Note
484+
485+
In pandas prior to version 0.18.1
486+
there is a bug causing `surveys_df['weight'].describe()` to
487+
return a runtime error.
488+
489+
:::::::::::::::::::::::::::::::::::::::::::::::::::::
490+
481491
We can also extract one specific metric if we wish:
482492

483493
```python

episodes/03-index-slice-subset.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@ exercises: 30
2525

2626
::::::::::::::::::::::::::::::::::::::::::::::::::
2727

28+
::::::::::::::::::::::: instructor
29+
30+
Tip: use `.head()` method throughout this lesson to keep your display neater for students.
31+
Encourage students to try with and without `.head()`
32+
to reinforce this useful tool and then to use it or not at their preference.
33+
34+
For example, if a student worries about keeping up in pace with typing,
35+
let them know they can skip the `.head()`,
36+
but that you'll use it to keep more lines of previous steps visible.
37+
38+
::::::::::::::::::::::::::::::::::
39+
2840
In the first episode of this lesson, we read a CSV file into a pandas' DataFrame. We learned how to:
2941

3042
- save a DataFrame to a named object,

episodes/07-visualization-ggplot-python.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,18 @@ To build a `plotnine` graphic we need to:
9292
(p9.ggplot(data=surveys_complete))
9393
```
9494

95+
::::::::::::::::::::::: instructor
96+
97+
Note `plotnine` contains a *lot* of deprecation warnings in some versions of python/matplotlib,
98+
warnings may need to be suppressed with
99+
100+
```python
101+
import warnings
102+
warnings.filterwarnings(action='once')
103+
```
104+
105+
::::::::::::::::::::::::::::::::::
106+
95107
As we have not defined anything else, just an empty figure is available and
96108
presented.
97109

instructors/instructor-notes.md

Lines changed: 15 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -25,48 +25,27 @@ If learners receive an `AssertionError`, it will inform you how to help them cor
2525
installation. Otherwise, it will tell you that the system is good to go and ready for Data
2626
Carpentry!
2727

28-
29-
## 02-starting-with-data
30-
31-
::::::::::::::::::::::::::::::::::::::::: callout
32-
33-
## Important Bug Note
34-
35-
In Pandas prior to 0.18.1 there is a bug causing `surveys_df['weight'].describe()` to return
36-
a runtime error.
37-
38-
::::::::::::::::::::::::::::::::::::::::::::::::::
39-
40-
## 03-index-slice-subset
41-
42-
Tip: use `.head()` method throughout this lesson to keep your display neater for students.
43-
Encourage students to try with and without `.head()` to reinforce this useful tool and then to use
44-
it or not at their preference. For example, if a student worries about keeping up in pace with
45-
typing, let them know they can skip the `.head()`, but that you'll use it to keep more lines of
46-
previous steps visible.
47-
4828
## 07-visualization-ggplot-python
4929

50-
Note `plotnine` contains a *lot* of deprecation warnings in some versions of python/matplotlib, warnings may need to be supressed with
51-
52-
```python
53-
import warnings
54-
warnings.filterwarnings(action='once')
55-
```
56-
5730
iPython notebooks for plotting can be viewed in the `learners` folder.
5831

5932
## 08-putting-it-all-together
6033

61-
Answers are embedded with challenges in this lesson, other than random distribtuion which is left to the learner to choose, and final plot, for which the learner should investigate the matplotlib gallery.
62-
63-
Scientists often operate on mathematical equations. Being able to use them in their graphics has a
64-
lot of added value. Luckily, Matplotlib provides powerful tools for text control. One of them is the
65-
ability to use LaTeX mathematical notation, whenever text is used (you can learn more about LaTeX
66-
math notation here: [https://en.wikibooks.org/wiki/LaTeX/Mathematics](https://en.wikibooks.org/wiki/LaTeX/Mathematics)). To use mathematical
67-
notation, surround your text using the dollar sign ("$"). LaTeX uses the backslash character ("\\")
68-
a lot. Since backslash has a special meaning in the Python strings, you should replace all the
69-
LaTeX-related backslashes with two backslashes.
34+
Answers are embedded with challenges in this lesson,
35+
other than random distribtuion which is left to the learner to choose,
36+
and final plot, for which the learner should investigate the matplotlib gallery.
37+
38+
Scientists often operate on mathematical equations.
39+
Being able to use them in their graphics has a lot of added value
40+
Luckily, Matplotlib provides powerful tools for text control.
41+
One of them is the ability to use LaTeX mathematical notation,
42+
whenever text is used
43+
(you can learn more about LaTeX math notation here: [https://en.wikibooks.org/wiki/LaTeX/Mathematics](https://en.wikibooks.org/wiki/LaTeX/Mathematics)).
44+
To use mathematical notation, surround your text using the dollar sign ("$").
45+
46+
LaTeX uses the backslash character ("\\") a lot.
47+
Since backslash has a special meaning in the Python strings,
48+
you should replace all the LaTeX-related backslashes with two backslashes.
7049

7150
```python
7251
plt.plot(t, t, 'r--', label='$y=x$')

0 commit comments

Comments
 (0)