Python Fixtures

pydoc is useful but it is not referenced from README so how do people know?

Bug #812845 reported by Jonathan Lange
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Python Fixtures
Fix Released
Wishlist
Robert Collins
Python Fixtures 0.3.11

Bug Description

The document at <http://pypi.python.org/pypi/fixtures> says:

Isolate your code from environmental variables, delete them or set them to a new value.

>>> fixture = fixtures.EnvironmentVariableFixture('HOME')

But it is not at all clear whether that isolates (how?), deletes or sets to a new value. Regardless of which it does, it's unclear how to achieve the other two without looking at the source code.

See original description
Jonathan Lange (jml)
description: updated
Revision history for this message
Robert Collins (lifeless) wrote :

This is why pydoc says for me;

    class EnvironmentVariableFixture(fixtures.fixture.Fixture)
     | Isolate a specific environment variable.
     |
     | Method resolution order:
     | EnvironmentVariableFixture
     | fixtures.fixture.Fixture
     | __builtin__.object
     |
     | Methods defined here:
     |
     | __init__(self, varname, newvalue=None)
     | Create an EnvironmentVariableFixture.
     |
     | :param varname: the name of the variable to isolate.
     | :param newvalue: A value to set the variable to. If None, the variable
     | will be deleted.
     |
     | During setup the variable will be deleted or assigned the requested
     | value, and this will be restored in cleanUp.
     |

That seems pretty clear to me. Was it unclear? Or did you go from 'README' -> source code without looking at the API docs ?

Changed in python-fixtures:
status: New → Incomplete
Revision history for this message
Jonathan Lange (jml) wrote : Re: [Bug 812845] Re: EnvironmentVariableFixture example is confusing

On Wed, Jul 20, 2011 at 9:20 PM, Robert Collins
<email address hidden> wrote:
...
> That seems pretty clear to me. Was it unclear? Or did you go from 'README' -> source code without looking at the API docs ?
>

The latter. Basically I never use pydoc.

jml

Revision history for this message
Robert Collins (lifeless) wrote : Re: EnvironmentVariableFixture example is confusing

So I don't want README to be pydoc-but-in-a-different-place. How about some text at the top saying pydoc (epydoc etc etc) have detailed usage information for individual facility.

Changed in python-fixtures:
status: Incomplete → Triaged
importance: Undecided → Wishlist
Revision history for this message
Jonathan Lange (jml) wrote :

Yeah, that'd be great. If you've got web hosting for the pydoc, it would be good to include a link to it.

Robert Collins (lifeless)
summary: - EnvironmentVariableFixture example is confusing
+ pydoc is useful but it is not referenced from README so how do people
+ know?
Robert Collins (lifeless)
Changed in python-fixtures:
milestone: none → next
assignee: nobody → Robert Collins (lifeless)
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.