[Checkins] SVN: zc.buildout/trunk/src/zc/buildout/testing.txt Update formatting.

Jim Fulton jim at zope.com
Sun Oct 1 11:15:12 EDT 2006


Log message for revision 70454:
  Update formatting.
  

Changed:
  U   zc.buildout/trunk/src/zc/buildout/testing.txt

-=-
Modified: zc.buildout/trunk/src/zc/buildout/testing.txt
===================================================================
--- zc.buildout/trunk/src/zc/buildout/testing.txt	2006-10-01 15:15:08 UTC (rev 70453)
+++ zc.buildout/trunk/src/zc/buildout/testing.txt	2006-10-01 15:15:11 UTC (rev 70454)
@@ -12,14 +12,14 @@
 The buildoutSetup function can be used as a doctest setup function.
 It performs adds a number of names to the test namespace:
 
-sample_buildout
+``sample_buildout``
     This is the name of a buildout with a basic configuration.
 
-ls(*path)
+``ls(*path)``
     List the contents of a directory.  The directory path is provided as one or
     more strings, to be joined with os.path.join.
 
-cat(*path)
+``cat(*path)``
     Display the contents of a file.   The file path is provided as one or
     more strings, to be joined with os.path.join.
 
@@ -27,15 +27,15 @@
     adding a '-script.py' suffix.  This helps to work around a
     difference in script generation on windows.
 
-mkdir(*path)
+``mkdir(*path)``
     Create a directory. The directory path is provided as one or
     more strings, to be joined with os.path.join.
 
-rmdir(*path)
+``rmdir(*path)``
     Remove a directory. The directory path is provided as one or
     more strings, to be joined with os.path.join.
 
-tmpdir(name)
+``tmpdir(name)``
     Create a temporary directory with the given name.  The directory
     will be automatically removed at the end of the test.  The path of
     the created directory is returned.
@@ -52,49 +52,48 @@
     Note that the sample_buildout directory is created by calling this
     function.
 
-write(*path_and_contents)
-
+``write(*path_and_contents)``
     Create a file.  The file path is provided as one or more strings,
     to be joined with os.path.join. The last argument is the file contents.
 
-system(command, input='')
+``system(command, input='')``
     Execute a system command with the given input passed to the
     command's standard input.  The output (error and regular output)
     from the command is returned.
 
-get(url)
+``get(url)``
     Get a web page.
 
-cd(*path)
+``cd(*path)``
     Change to the given directory.  The directory path is provided as one or
     more strings, to be joined with os.path.join.
 
     The directory will be reset at the end of the test.
 
-join(*path)
+``join(*path)``
     A convenient reference to os.path.join.
 
-register_teardown(func)
+``register_teardown(func)``
     Register a tear-down function.  The function will be called with
     no arguments at the end of the test.
 
-start_server(path)
+``start_server(path)``
     Start a web server on the given path.  The server will be shut
     down at the end of the test.  The server URL is returned.
 
-sdist(setup, dest)
+``sdist(setup, dest)``
     Create a source distribution by running the given setup file and
     placing the result in the given destination directory.  If the
     setup argument is a directory, the thge setup.py file in that
     directory is used.
 
-bdist_egg(setup, executable, dest)
+``bdist_egg(setup, executable, dest)``
     Create an egg by running the given setup file with the given
     Python executable and placing the result in the given destination
     directory.  If the setup argument is a directory, the thge
     setup.py file in that directory is used.
 
-find_python(version)
+``find_python(version)``
     Find a Python executable for the given version, where version is a
     string like "2.4".
 
@@ -108,14 +107,14 @@
     - on Unix, try running python%(version)s or just python to get the
       executable
 
-zc.buildout.testing.buildoutTearDown(test)
-------------------------------------------
+``zc.buildout.testing.buildoutTearDown(test)``
+----------------------------------------------
 
 Tear down everything set up by zc.buildout.testing.buildoutSetUp.  Any
 functions passed to register_teardown are called as well.
 
-install(project, destination)
------------------------------
+``install(project, destination)``
+---------------------------------
 
 Install eggs for a given project into a destination.  If the
 destination is a test object, then the eggs directory of the
@@ -125,14 +124,14 @@
 to be used should already be loaded, by importing one of the modules
 provided, before calling this function.
 
-install_develop(project, destination)
--------------------------------------
+``install_develop(project, destination)``
+-----------------------------------------
 
 Like install, but a develop egg is installed even if the current egg
 if not a develop egg.
 
-Output normalization
---------------------
+``Output normalization``
+------------------------
 
 Recipe tests often generate output that is dependent on temporary file
 locations, operating system conventions or Python versions.  To deal
@@ -144,17 +143,17 @@
 pairs that you can pass to zope.testing.renormalizing.RENormalizing.
 
 
-normalize_path
+``normalize_path``
    Converts tests paths, based on directories created with tmpdir(),
    to simple paths.
 
-normalize_script
+``normalize_script``
    On Unix-like systems, scripts are implemented in single files
    without suffixes.  On windows, scripts are implemented with 2
    files, a -script.py file and a .exe file.  This normalization
    converts directory listings of Windows scripts to the form
    generated on UNix-like systems.
 
-normalize_egg_py
+``normalize_egg_py``
    Normalize Python version and platform indicators, if specified, in
    egg names.



More information about the Checkins mailing list