Issue 291 in pyftpdlib: Docs of packages and classes

[pyft...@googlecode.com]

Status: New
Owner: karl.ric...@gmail.com
Labels: Type-Defect Priority-Medium Component-Library

New issue 291 by karl.ric...@gmail.com: Docs of packages and classes
http://code.google.com/p/pyftpdlib/issues/detail?id=291

After <code>import pyftpdlib</code> the help command doesn't provide
documentation for packages and classes, e.g.
<code>help(pyftpdlib.servers)</code> and
<code>help(pyftpdlib.servers.FTPServer)</code>

I'm missing documentation of the parameters of
pyftpdlib.servers.FTPServer.serve_forever, e.g. handle_exit which is also
not present in the Tutorial at
https://code.google.com/p/pyftpdlib/wiki/Tutorial, but I'd suggest to
rather add docs (for packages and classes) (or at least add a stub for the
help command pointing to the (online!) tutorial) than improving the wiki or
syncing the both with pandoc or an alternative.

--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[pyft...@googlecode.com]

Comment #1 on issue 291 by g.rodola: Docs of packages and classes
http://code.google.com/p/pyftpdlib/issues/detail?id=291

What do you mean?
This works:

>>> from pyftpdlib.servers import FTPServer
>>> help(FTPServer)

...and this works too:

>>> import pyftpdlib.servers
>>> help(pyftpdlib.servers)

Again, I'm not sure what's your problem. It seems you're simply looking for
documentation, which is here:
https://code.google.com/p/pyftpdlib/wiki/Tutorial

[pyft...@googlecode.com]

Comment #2 on issue 291 by karl.ric...@gmail.com: Docs of packages and
classes
http://code.google.com/p/pyftpdlib/issues/detail?id=291

Ah, ok, I didn't know that it is possible that one has to import
subnamespaces explicitly (thought about <code>import os;
help(os.path)</code>). Documentation is in sync with the tutorial, too, so
the report is completely invalid...

[pyft...@googlecode.com]

Updates:
Status: Invalid

Comment #3 on issue 291 by g.rodola: Docs of packages and classes
http://code.google.com/p/pyftpdlib/issues/detail?id=291

(No comment was entered for this change.)