Skip to main content

A decorator used to inherit method documentation from parent classes.

Project description

A decorator used to inherit method documentation from parent classes.

Badges

https://img.shields.io/travis/kavdev/python-doc-inherit/master.svg?style=flat-square https://img.shields.io/codecov/c/github/kavdev/python-doc-inherit/master.svg?style=flat-square https://img.shields.io/requires/github/kavdev/python-doc-inherit.svg?style=flat-square https://img.shields.io/codacy/75dbe2685efe47c3aa203a53154c9e7e.svg?style=flat-square https://img.shields.io/pypi/v/python-doc-inherit.svg?style=flat-square https://img.shields.io/pypi/dw/python-doc-inherit.svg?style=flat-square https://img.shields.io/github/issues/kavdev/python-doc-inherit.svg?style=flat-square https://img.shields.io/github/license/kavdev/python-doc-inherit.svg?style=flat-square

Usage

Install python-doc-inherit:

pip install python-doc-inherit

Put it to use:

from doc_inherit import method_doc_inherit

class Foo(object):

    def foo(self):
        """Frobber"""

        pass

class Bar(Foo):

    @method_doc_inherit
    def foo(self):
        pass

Now, Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == "Frobber"

Running the Tests

pip install -r requirements/test.txt
./runtests.py

Changes

0.1.0 (2016-06-18)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-doc-inherit-0.1.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

python_doc_inherit-0.1.0-py2.py3-none-any.whl (4.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file python-doc-inherit-0.1.0.tar.gz.

File metadata

File hashes

Hashes for python-doc-inherit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a4a161d66b55801f996a6bb5f07cbf519cad31d475567b68287b4717bc194b85
MD5 5a8593bb037c51b1bf42512d08123aee
BLAKE2b-256 4617d1d5c7adb9be01d1b29247127795cab7ae47ab3e4b588afbade8851a1e6d

See more details on using hashes here.

File details

Details for the file python_doc_inherit-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_doc_inherit-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 41595de28050284c41503ab4f7b0b3a5e901027b1002cf34b8d04f7fc9e83226
MD5 d9d3d59a013182210126406ba90625fd
BLAKE2b-256 26211332806b8f274693830d85701b689ba506d7818d76a40203ee8315eaa270

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page