Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Force pdoc to generate documentation for __get__? #33

Open
leotrs opened this issue Feb 25, 2015 · 0 comments

Comments

Projects
None yet
1 participant
@leotrs
Copy link

commented Feb 25, 2015

Attached is a simple example where pdoc doesn't generate documentation for the __get__ method of a class. My guess is this method is considered not public, which seems reasonable.
Is there a way to force pdoc to process it still?

class Base(object):
    def __init__(self):
        """Constructor."""
        self.x = 1

    def __get__(self, instance, owner):
        "Set method."
        return self.x

And the output:

leo@lily:~/$ pdoc test.py
Module test
-----------

Classes
-------
Base 
    Ancestors (in MRO)
    ------------------
    test.Base
    __builtin__.object

    Instance variables
    ------------------
    x

    Methods
    -------
    __init__(self)
        Constructor.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.