[Freeipa-devel] [PATCH] Add more sophisticated help interface. Split commands into 'topics'.

[Rob Crittenden]

David O'Brien wrote:
> Jason Gerard DeRose wrote:
>> As mentioned, in this case I we should use more concise docstrings
>> instead.  I think it's a great idea to have the CLI help and the
>> documentation be consistent where possible, but the help docstrings have
>> very space constrained because ideally the should be short enough as to
>> not wrap on a 80 character wide terminal.
>>
>>   
> OK, I'm happy to go either way, providing suggestions like I am here, or 
> being more actively involved, editing directly and providing patches. 
> What's the process?

Pull the source to our git tree:

git clone git://git.fedorahosted.org/git/freeipa.git

Modify the docstrings in the plugins (ipalib/plugins/*.py)

In this case the docstring to look at is the first one after the 
copyright. It will look something like the one in user.py:

"""
Frontend plugins for user (Identity).
"""

Make your change, commit it and send a patch to this list:

$ <insert-editor-here> ipalib/plugins/<someplugin>
[ repeat as needed ]
$ git commit -a
$ git format-patch -1
$ [send the output file to this list as an attachment]

Note that the -1 for the git format-patch pulls only the *last* change 
you did. I'd recommend this way for starting out so you can clearly see 
what changes have been made and sent for review.

rob