python-doc-inherit 0.3.0

Description:

pythondocinherit 0.3.0

==================python-doc-inherit==================Utilities to inherit method documentation from parent classes.Badges------.. image:: https://img.shields.io/travis/kavdev/python-doc-inherit/master.svg?style=flat-square :target: https://travis-ci.org/kavdev/python-doc-inherit.. image:: https://img.shields.io/codecov/c/github/kavdev/python-doc-inherit/master.svg?style=flat-square :target: http://codecov.io/github/kavdev/python-doc-inherit?branch=master.. image:: https://img.shields.io/requires/github/kavdev/python-doc-inherit.svg?style=flat-square :target: https://requires.io/github/kavdev/python-doc-inherit/requirements/?branch=master.. image:: https://img.shields.io/codacy/75dbe2685efe47c3aa203a53154c9e7e.svg?style=flat-square :target: https://www.codacy.com/app/kavanaugh-development/python-doc-inherit/dashboard.. image:: https://img.shields.io/pypi/v/python-doc-inherit.svg?style=flat-square :target: https://pypi.python.org/pypi/python-doc-inherit.. image:: https://img.shields.io/pypi/dw/python-doc-inherit.svg?style=flat-square :target: https://pypi.python.org/pypi/python-doc-inherit.. image:: https://img.shields.io/github/issues/kavdev/python-doc-inherit.svg?style=flat-square :target: https://github.com/kavdev/python-doc-inherit/issues.. image:: https://img.shields.io/github/license/kavdev/python-doc-inherit.svg?style=flat-square :target: https://github.com/kavdev/python-doc-inherit/blob/master/LICENSEInstallation------------Install python-doc-inherit:.. code-block:: bash pip install python-doc-inheritUsage-----Simple method decorator (will cause other decorators to fail)~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.. code-block:: python from doc_inherit import method_doc_inherit class Foo(object): def foo(self): """Frobber""" pass class Bar(Foo): @method_doc_inherit def foo(self): passNow, ``Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == "Frobber"``Simple class decorator~~~~~~~~~~~~~~~~~~~~~~.. code-block:: python from doc_inherit import class_doc_inherit class Foo(object): def foo(self): """Frobber""" pass @class_doc_inherit class Bar(Foo): def foo(self): passNow, ``Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == "Frobber"``Metaclass~~~~~~~~~.. code-block:: python from doc_inherit.metaclasses import DocStringInheritor from six import add_metaclass # Note: Six is not included in this distribution. class Animal: def move_to(self, dest): """Move to *dest*""" pass @add_metaclass(DocStringInheritor) class Bird(Animal): def move_to(self, dest): passNow, ``Animal.move_to.__doc__ == Bird.move_to.__doc__ == "Move to *dest*"``Running the Tests------------------.. code-block:: bash pip install -r requirements/test.txt ./runtests.pyChanges=======0.1.1 (2016-06-18)----------------------* small fixes0.1.0 (2016-06-18)----------------------* Initial release