CODEWITHSUNDEEP
pythonfunctionspyder
user1984653
user1984653

Reputation: 590

How to write help/description text for Python functions

I recently started programming using Python. I have to write many functions and was wondering how I can incorporate a help or description text such that it appears in the object inspector of spyder when I call the function. In MatLab, this worked by putting commented text at the beginning of the function file. Is there a similar method in Python (using Spyder)?

Upvotes: 31

Views: 98045

Answers (3)

Carlos Cordoba
Carlos Cordoba

Reputation: 34156

(Spyder maintainer here) There are other couple of things you need to know (besides what @burhan-khalid mentioned) regarding Spyder itself:

  1. If you want to see your docstrings nicely formatted in the Help pane, you need to write them following the numpydoc standard, which is explained here. This is a set of conventions used by almost all python scientific packages to write their docstrings. It's not mandatory but we follow it too while converting docstrings (which come in plain text) to html.

  2. You have to use Ctrl+I in front of an object's name to show their help in our Help pane.

Upvotes: 11

Burhan Khalid
Burhan Khalid

Reputation: 174622

By default, the first string in the body of a method is used as its docstring (or documentation string). Python will use this when help() is called for that method.

def foo(bar):
    """
    Takes bar and does some things to it.
    """
    return bar

help(foo)
foo(bar)
    Takes bar and does
    some things to it

You can read more about how this works by reading PEP-258, and this question goes into some more details.

Upvotes: 65

Gerardsson
Gerardsson

Reputation: 382

In a short answer. This can be done by putting text between triple quotes.

'''
@param self
'''

You can find a brief example on this link: https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html#

The other answers are more extensive.

Upvotes: 7

Related Questions