What does the Pydoc module do?

python terminal pydoc
logan beaupre picture logan beaupre · Feb 6, 2014 · Viewed 56.9k times · Source

New to programming and python altogether. In the book I'm learning from, the author suggested I find out the purpose of Pydoc.

I did a google search on it, and found a match (from Gnome Terminal) but it didn't make much sense to me. Anyone mind simplifying a bit?

Answer

Kapil Marwaha picture Kapil Marwaha · Oct 24, 2015

Pydoc is a help / documentation module for Python.

Use this on your Windows terminal to understand what a function in python does :

python -m pydoc <function>

eg.

python -m pydoc raw_input

If the documentation for a particular function is very long, use 'q' to get out of it.

e.g. in case of 

python -m pydoc Tkinter

Related questions

How to call an external command?

How do you call an external command (as if I'd typed it at the Unix shell or Windows command prompt) from within a Python script?

Read More
How to print colored text in Python?

How can I output colored text to the terminal in Python?

Read More
Why is the apt-get function not working in the terminal on Mac OS X v10.9 (Mavericks)?

I was watching this, and, as you can see, the first command I am told to put in is: sudo apt-get install python-setuptools When I do this, it outputs: sudo: apt-get: command not found I have no idea why this …

Read More