[Tutor] Basic question about docstrings

David Aldrich David.Aldrich at EMEA.NEC.COM
Thu Jul 30 10:24:27 CEST 2015


>> If I have a script called main.py and document a function in it:
>>
>> def get_value(x):
>>     """
>>     Some text ...
>>     :param x:     Some value
>>     :returns:      Something useful
>>     """
>>
>> What is the most basic way of showing those docstrings at the Python 
>> prompt?
>
> Try:
>
>    help(get_value)
>
> At the Python prompt.  This uses the built in help facility:
>
> https://docs.python.org/2/library/functions.html#help
>

I understand that 'help' works with modules that I have imported. But if I've just written a script called main.py (which contains get_value()) I don't think I can 'import' that. So how would I see the docstrings in main.py?



More information about the Tutor mailing list