best text editor for programming Python on a Mac

alister alister.ware at ntlworld.com
Sat Jun 18 09:22:13 EDT 2016


On Sat, 18 Jun 2016 12:40:09 +0300, Marko Rauhamaa wrote:

> 
>> - integrated documentation so you don't have to lookup the syntax and
>> arguments of a function
> 
> I have seen that in action with eclipse and Java. It could never match
> having a web browser window next to the editor window: <URL:
> https://docs.python.org/3/library/>.
> 
> It would be nice if python provided a full set of man pages as well as
> info documentation like C. Those are integrated into emacs.
> 
pydoc - I think Guido's time machine strikes again :-)

pydoc - the Python documentation tool

pydoc <name> ...
    Show text documentation on something.  <name> may be the name of a
    Python keyword, topic, function, module, or package, or a dotted
    reference to a class or function within a module or module in a
    package.  If <name> contains a '/', it is used as the path to a
    Python source file to document. If name is 'keywords', 'topics',
    or 'modules', a listing of these things is displayed.

pydoc -k <keyword>
    Search for a keyword in the synopsis lines of all available modules.

pydoc -p <port>
    Start an HTTP server on the given port on the local machine.  Port
    number 0 can be used to get an arbitrary unused port.

pydoc -w <name> ...
    Write out the HTML documentation for a module to a file in the current
    directory.  If <name> contains a '/', it is treated as a filename; if
    it names a directory, documentation is written for all the contents.

as it uses docstrings it should work well with any reasonably well 
written module - (even your own)




-- 
... The prejudices people feel about each other disappear when they get
to know each other.
		-- Kirk, "Elaan of Troyius", stardate 4372.5


More information about the Python-list mailing list