[MERGE] small updates to doc strings

[Aaron Bentley]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

John Arbash Meinel wrote:
> The attached patch just cleans up some of our docstrings to make epydoc happy.
> 
> It is something I've had lying around for a while, and just never got submitted.
> 
> So here goes.
> 
> It doesn't clean up all errors, but it is at least a start in getting 'make
> api-docs' to be happy.
> 
> By the way, with bzrtools installed, I get some really weird results.
> Specifically, when I run "make api-docs" I get:
> 
> Error importing 'bzrlib.plugins.bzrtools.setup': usage: (imported)
> [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
>    or: (imported) --help [cmd1 cmd2 ...]
>    or: (imported) --help-commands
>    or: (imported) cmd --help
> 
> error: no commands supplied
> ........1 out of 1 hunk FAILED -- saving rejects to file test_file.rej
> 
> 
> It really looks like it is somehow running the bzrtools test suite. Any ideas
> why it would be doing that?

I'm not sure how it's finding bzrtools, but if it's importing all
modules, it's importing test.py and setup.py.  Those are only for use as
scripts, so they don't have the usual "if __name__ == '__main__'" wrapper.

Aaron
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFGhUB60F+nu1YWqI0RApAvAJ9t9Ul3/UqWe4hzQi7SQPEzQ0cVLQCghNhS
EOX9Z25Twi00pFez94WUMkk=
=rwAR
-----END PGP SIGNATURE-----