Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 10074ad

Browse files
committed
A few formatting fixes
1 parent 46f725e commit 10074ad

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Notes/InstructorNotes.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Section 3.4 Introduces module imports. The file written in Section
196196
may need to help students fix issues with IDLE, sys.path, and other
197197
assorted settings related to import.
198198

199-
Section 3.5 talks about __main__ and script writing. There's a bit
199+
Section 3.5 talks about `__main__` and script writing. There's a bit
200200
about command line arguments. You might be inclined to discuss a
201201
module like argparse. However, be warned that doing so opens up
202202
a quagmire. It's usually better to just mention it and move on.
@@ -256,8 +256,8 @@ commonly used in libraries and frameworks--especially in situations
256256
where more control over what a user is allowed to do is desired.
257257

258258
An astute Python master will notice that I do not talk about advanced
259-
topics such as descriptors, or attribute access methods (__getattr__,
260-
__setattr__) at all. I have found, through experience, that this is
259+
topics such as descriptors, or attribute access methods (`__getattr__`,
260+
`__setattr__`) at all. I have found, through experience, that this is
261261
just too much mental overload for students taking the intro course.
262262
Everyone’s head is already on the verge of exploding at this point and
263263
if you go talk about how something like descriptors work, you’ll lose
@@ -285,7 +285,7 @@ and think about streams, large datasets, etc.
285285

286286
Some omissions: Although the iteration protocol is described, the
287287
notes don’t go into detail about creating iterable objects (i.e.,
288-
classes with __iter__() and next()). In practice, I’ve found that
288+
classes with `__iter__()` and `next()`). In practice, I’ve found that
289289
it’s not necessary to do this so often (generators are often
290290
better/easier). So, in the interest of time, I’ve made a conscious
291291
decision to omit it. Also not included are extended generators
@@ -329,7 +329,7 @@ follow.py, etc.). Two main goals in this section. First, put all of
329329
the code into a Python package structure. This is only a gentle
330330
introduction to that, but they'll move the files into a directory and
331331
everything will break. They'll need to fix their import statements
332-
(package relative imports) and maybe fiddle with an __init__.py file.
332+
(package relative imports) and maybe fiddle with an `__init__.py` file.
333333
Second goal, write a simple setup.py file that they can use to package
334334
up the code and give it away to someone. That's it. End of the
335335
course.

0 commit comments

Comments
 (0)