Skip to content

Commit 9b92667

Browse files
committed
Better describe why the README is auto-generated.
1 parent 778ece8 commit 9b92667

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

generate-readme.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55

66
"""
77
Generates the README for
8-
[bamos/python-scripts](https://github.com/bamos/python-scripts).
9-
Script descriptions are obtained by parsing the docstrings.
8+
[bamos/python-scripts](https://github.com/bamos/python-scripts)
9+
so that the README and scripts contain synchronized documentation.
10+
Script descriptions are obtained by parsing the docstrings
11+
and inserted directly into the README as markdown.
1012
"""
1113

1214
import ast
@@ -21,7 +23,8 @@
2123
2224
This is a collection of short Python scripts use in Linux.
2325
Portions of this README are automatically generated with
24-
[generate-readme.py](https://github.com/bamos/python-scripts#generate-readmepy).
26+
[generate-readme.py](https://github.com/bamos/python-scripts#generate-readmepy)
27+
to insert the script-level comments as descriptions below.
2528
2629
# Adding to your PATH
2730
I have these added to my `PATH`

0 commit comments

Comments
 (0)