[py-svn] r63548 - py/trunk/doc
hpk at codespeak.net
hpk at codespeak.net
Thu Apr 2 20:59:33 CEST 2009
Author: hpk
Date: Thu Apr 2 20:59:31 2009
New Revision: 63548
Modified:
py/trunk/doc/coding-style.txt
py/trunk/doc/contact.txt
py/trunk/doc/impl-test.txt
py/trunk/doc/index.txt
py/trunk/doc/misc.txt
py/trunk/doc/test-ext.txt
py/trunk/doc/test-features.txt
py/trunk/doc/test.txt
Log:
fixing lots of little issues with the docs
Modified: py/trunk/doc/coding-style.txt
==============================================================================
--- py/trunk/doc/coding-style.txt (original)
+++ py/trunk/doc/coding-style.txt Thu Apr 2 20:59:31 2009
@@ -61,11 +61,5 @@
- Try to put the tests close to the tested code, don't
overload directories with names.
-- If you think of exporting new py lib APIs, discuss it first on the
- `py-dev mailing list`_ and possibly write a chapter in our
- `future_` book. Communication is considered a key here to make
- sure that the py lib develops in a consistent way.
-
.. _`PEP 8 Style Guide for Python Code`: http://www.python.org/peps/pep-0008.html
.. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev
-.. _`future`: future.html
Modified: py/trunk/doc/contact.txt
==============================================================================
--- py/trunk/doc/contact.txt (original)
+++ py/trunk/doc/contact.txt Thu Apr 2 20:59:31 2009
@@ -16,8 +16,6 @@
.. _`merlinux.eu`: http://merlinux.eu
-.. _future: future.html
-
.. _`get an account`:
.. _tetamap: http://tetamap.wordpress.com
Modified: py/trunk/doc/impl-test.txt
==============================================================================
--- py/trunk/doc/impl-test.txt (original)
+++ py/trunk/doc/impl-test.txt Thu Apr 2 20:59:31 2009
@@ -2,7 +2,6 @@
ATTIC documentation
===============================================
-
XXX REVIEW and remove the below XXX
Modified: py/trunk/doc/index.txt
==============================================================================
--- py/trunk/doc/index.txt (original)
+++ py/trunk/doc/index.txt Thu Apr 2 20:59:31 2009
@@ -33,11 +33,7 @@
.. _`py.test`: test.html
.. _`py lib scripts`: bin.html
.. _`py.xml`: xml.html
-.. _`Why What how py?`: why_py.html
-.. _`future`: future.html
.. _`miscellaneous features`: misc.html
-.. _`0.9.2 release announcement`: release-0.9.2.html
-
Full Contents
===================================
@@ -64,4 +60,3 @@
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
Modified: py/trunk/doc/misc.txt
==============================================================================
--- py/trunk/doc/misc.txt (original)
+++ py/trunk/doc/misc.txt Thu Apr 2 20:59:31 2009
@@ -2,7 +2,6 @@
Miscellaneous features of the py lib
====================================
-
Mapping the standard python library into py
===========================================
@@ -52,32 +51,14 @@
local paths have ``sysexec``
----------------------------
-The py lib currently offers a stripped down functionality of what
-the new `PEP-324 subprocess module`_ offers. The main functionality
-of synchronously executing a system executable has a straightforward API::
+In order to synchronously execute an executable file you
+can use ``sysexec``::
binsvn.sysexec('ls', 'http://codespeak.net/svn')
where ``binsvn`` is a path that points to the ``svn`` commandline
-binary. Note that this function would not offer any shell-escaping
-so you really have to pass in separated arguments. This idea
-fits nicely into `a more general view on path objects`_.
-
-For a first go, we are just reusing the existing `subprocess
-implementation`_ but don't expose any of its API apart
-from the above ``sysexec()`` method.
-
-Note, however, that currently the support for the ``sysexec`` interface on
-win32 is not thoroughly tested. If you run into problems with it, we are
-interested to hear about them. If you are running a Python older than 2.4 you
-will have to install the `pywin32 package`_.
-
-
-.. _`future book`: future.html
-.. _`PEP-324 subprocess module`: http://www.python.org/peps/pep-0324.html
-.. _`subprocess implementation`: http://www.lysator.liu.se/~astrand/popen5/
-.. _`a more general view on path objects`: future.html#general-path
-.. _`pywin32 package`: http://pywin32.sourceforge.net/
+binary. Note that this function does not offer any shell-escaping
+so you have to pass in already separated arguments.
finding an executable local path
--------------------------------
Modified: py/trunk/doc/test-ext.txt
==============================================================================
--- py/trunk/doc/test-ext.txt (original)
+++ py/trunk/doc/test-ext.txt Thu Apr 2 20:59:31 2009
@@ -51,9 +51,6 @@
Test Collection process
======================================================
-.. module:: py.test.collect
- :synopsis: basic test collection classes
-
The collecting process is iterative so that distribution
and execution of tests can start as soon as the first test
item is collected. Collection nodes with children are
@@ -110,22 +107,9 @@
the trailing ``.py``.
-
-
-
-Plugin methods
-=======================================
-
-.. module:: py.__.test.pluginapi
-
-A Plugin class may implement the following attributes and methods:
-
-XXX
-
-_`pytest event`:
-
-Pytest Events
+Plugin hooks and events
=======================================
-XXX
+See definitions at
+http://codespeak.net/svn/py/trunk/py/test/plugin/api.py
Modified: py/trunk/doc/test-features.txt
==============================================================================
--- py/trunk/doc/test-features.txt (original)
+++ py/trunk/doc/test-features.txt Thu Apr 2 20:59:31 2009
@@ -23,7 +23,7 @@
or class with a leading ``Test`` name is collected.
.. _`generative tests`:
-.. _`collection process`: impl-test.html#collection-process
+.. _`collection process`: test-ext.html#collection-process
load-balance tests to multiple CPUs
===================================
Modified: py/trunk/doc/test.txt
==============================================================================
--- py/trunk/doc/test.txt (original)
+++ py/trunk/doc/test.txt Thu Apr 2 20:59:31 2009
@@ -24,7 +24,6 @@
.. _`distributed testing`: test-dist.html
-
Contents:
.. toctree::
More information about the pytest-commit
mailing list