Next / Previous / Contents / Shipman's homepage

4.2. The prologue

The script starts with the usual Python prologue. The first line makes the script self-executing. This is followed by minimal comments pointing to the online form of the literate programming document, and the Cleanroom intended function for the program as a whole.

litlxml
#!/usr/bin/env python
#================================================================
# litlxml:  Extract code from literate-programming source files.
#   Do not edit this file.  It is extracted automatically from
#   the documentation:
#       http://www.nmt.edu/~shipman/soft/litlxml/
#----------------------------------------------------------------
# Overall intended function:
#   [ output files named in input files given on the command line
#         :=  code fragments designated for those files
#     sys.stderr  +:=  error messages if any ]
#----------------------------------------------------------------