##// END OF EJS Templates
Allow to dispatch getting documentation on objects...
Allow to dispatch getting documentation on objects Base for #13860, so that object can be queried for documentation on their fields/properties. Typically this allows the following, to extend the doc documentation when requesting information on a field. In [1]: class DictLike: ...: def __getitem__(self, k): ...: if k.startswith('f'): ...: return "documentation for k" ...: else: ...: raise KeyError ...: ...: class Bar: ...: __custom_documentations__ = DictLike() ...: ...: faz = 1 ...: ...: ...: @property ...: def foo(self): ...: return 1 ...: b = Bar() In [2]: b.faz?
Matthias Bussonnier -
r28195:fc872d6c
Show More
Name Size Modified Last Commit Author
/ IPython / testing / plugin
Makefile Loading ...
README.txt Loading ...
__init__.py Loading ...
dtexample.py Loading ...
ipdoctest.py Loading ...
pytest_ipdoctest.py Loading ...
setup.py Loading ...
simple.py Loading ...
simplevars.py Loading ...
test_combo.txt Loading ...
test_example.txt Loading ...
test_exampleip.txt Loading ...
test_ipdoctest.py Loading ...
test_refs.py Loading ...

=======================================================
Nose plugin with IPython and extension module support
=======================================================

This directory provides the key functionality for test support that IPython
needs as a nose plugin, which can be installed for use in projects other than
IPython.

The presence of a Makefile here is mostly for development and debugging
purposes as it only provides a few shorthand commands. You can manually
install the plugin by using standard Python procedures (``setup.py install``
with appropriate arguments).

To install the plugin using the Makefile, edit its first line to reflect where
you'd like the installation.

Once you've set the prefix, simply build/install the plugin with::

make

and run the tests with::

make test

You should see output similar to::

maqroll[plugin]> make test
nosetests -s --with-ipdoctest --doctest-tests dtexample.py
..
----------------------------------------------------------------------
Ran 2 tests in 0.016s

OK