Skip to content

Commit 026f526

Browse files
committed
edit readme
1 parent 9e4de23 commit 026f526

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This course covers several topics
66
- [Python decorators](https://github.com/MoserMichael/python-obj-system/blob/master/decorator.md)
77
- Also see my text on [Python import system](https://github.com/MoserMichael/pythonimportplayground)
88

9-
The lessons are python files, these are run to create the markdown text for the lesson.
10-
It uses a kind of [literate programming tool](https://en.wikipedia.org/wiki/Literate_programming) developed for this course, which formats the output of the script in markdown format.
9+
Each lesson is a python program, the output of that program is a lesson, rendered a markdown text.
10+
I am using a kind of [literate programming tool](https://en.wikipedia.org/wiki/Literate_programming) developed for this course.
1111
The tool is right here in this repository, in the [mdformat package](https://github.com/MoserMichael/python-obj-system/tree/master/mdformat)
1212

1313
The main function of the [mdformat package](https://github.com/MoserMichael/python-obj-system/tree/master/mdformat) is ```eval_and_quote(string_arg)```. This function does the following steps:

decorator.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -577,11 +577,19 @@ def from_name(cls_, colour_name, alpha):
577577
cval = Colour.from_name(colour_name)
578578
return cls_(cval.red, cval.green, cval.blue, alpha)
579579
580-
# now you can create a named colour with the same factory method from_name
581-
# It calls the correct method, based on the class name of the call ColourWithAlphaChannel.from_name( "red", 1.0)
580+
# now you can create a named colour with the same constructor/factory method from_name
581+
# It calls the correct method, based on the class name of the call ColourWithAlphaChannel.from_name("red", 1.0)
582582
583583
colour_red = ColourWithAlphaChannel.from_name( "red", 1.0)
584584
print("color red: ", colour_red , "red:", colour_red.red , "green:", colour_red.green, "blue:", colour_red.blue, "alpha:", colour_red.alpha)
585585
""")
586586

587+
header_md("The functools library", nesting=3)
588+
589+
print_md("""
590+
The [functools library](https://docs.python.org/3/library/functools.html) comes as part of the python standard library.
591+
This library comes with some interesting decorators.
592+
593+
""")
594+
587595
print("*** eof tutorial ***")

0 commit comments

Comments
 (0)