[Python-checkins] cpython: Add examples to the module docstring
raymond.hettinger
python-checkins at python.org
Tue Jul 3 23:42:40 CEST 2012
http://hg.python.org/cpython/rev/1401ff261ced
changeset: 77942:1401ff261ced
user: Raymond Hettinger <python at rcn.com>
date: Tue Jul 03 14:42:33 2012 -0700
summary:
Add examples to the module docstring
files:
Tools/scripts/highlight.py | 26 +++++++++++++++++++++-----
1 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/Tools/scripts/highlight.py b/Tools/scripts/highlight.py
--- a/Tools/scripts/highlight.py
+++ b/Tools/scripts/highlight.py
@@ -1,5 +1,21 @@
#!/usr/bin/env python3
-'Add syntax highlighting to Python source code'
+'''Add syntax highlighting to Python source code
+
+Example command-line calls:
+
+ # Show syntax highlighted code in the terminal window
+ $ ./highlight.py -a myfile.py
+
+ # Colorize myfile.py and display in a browser
+ $ ./highlight.py -b myfile.py
+
+ # Create an HTML section that can be embedded in an existing webpage
+ ./highlight.py -s myfile.py
+
+ # Create a complete HTML file
+ $ ./highlight.py myfile.py > myfile.html
+
+'''
__all__ = ['colorize', 'build_page', 'default_css', 'default_html',
'ansi_colorize', 'default_ansi']
@@ -150,14 +166,14 @@
sourcefile = args.sourcefile
with open(sourcefile) as f:
- page = f.read()
+ source = f.read()
if args.ansi:
- encoded = colorize_ansi(page)
+ encoded = colorize_ansi(source)
elif args.section:
- encoded = colorize_html(page)
+ encoded = colorize_html(source)
else:
- encoded = build_page(page, title=sourcefile)
+ encoded = build_page(source, title=sourcefile)
if args.browser:
htmlfile = os.path.splitext(os.path.basename(sourcefile))[0] + '.html'
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list