Add help to python module

Question

I use Spyder and for example numpy. Then, when I use some function, like np.interp(), object inspector gives me help about this function. How to put documentation into my modules which will be displayed in Spyder's object inspector?

Marcus Müller · Accepted Answer · 2015-02-20 11:30:33Z

2

That would be python documentation comments:

"""
This module contains methods and classes
"""

class class_:
    """
    This class is well... a class
    """
    def method(self, in_):
        """
        This method takes one argument: in_ and returns it
        """
        return in_

answered Feb 20, 2015 at 11:30

Marcus Müller

36.9k4 gold badges59 silver badges105 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Add help to python module

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related