jaraco  committed a1e7112

Added a bit of documentation for clarity

  • Participants
  • Parent commits 301c2cb
  • Branches default

Comments (0)

Files changed (1)

File sphinx/util/

+%prog <filename>
+A utility script for performing some commonly-encountered patterns in
+Trac Wiki format into reStructuredText (rst).
+filename is the name of the text file to be saved. If -U is not used,
+the file is converted in-place and filename is also the name of the
 from __future__ import print_function
 import sys
 import re
 def get_options():
 	global options
-	parser = optparse.OptionParser()
+	parser = optparse.OptionParser(usage=inspect.cleandoc(__doc__))
 	parser.add_option('-U', '--url', help="Trac URL from which to retrieve source")
 	options, args = parser.parse_args()