Re: [Gimp-developer] Improving pygimp documentation

I am sorry - 
this is not the way to proceed. 

There is no GIMP's "built-in help" - GIMP_Python does use
standard Python's help - and that should no tchange.
What standard Python help does is to display the function signature,
when available, and the contents of the object's __doc__ attribute.

Your approach could lead to a a patch to dynamically provide the __doc__ 
attributes of PDB items - taht would be ok. For the builtin items,
such as Layer, Image and such, as the code is today, 
the documentation would have to be hard-coded in the C files, however.


On 3 March 2013 22:25, Sean Munkel <seanmunkel gmail com> wrote:
I know that the documentation of pygimp itself is a bigger priority
than this, but I've been experimenting with a way to dynamically
generate the documentation for procedures based on the metadata that
they have. It automatically converts the parameters to the correct
python type (though admittedly that wasn't exactly that confusing),
makes sure that things fit nicely in the default python console (on
Windows at least), and most importantly makes the handling of the
run_mode keyword argument clearer. Aside from this is there a good way
to approach improving the documentation for pygimp? I know that the
documentation for gimpplugin is pretty scares and gimpui and gimpthumb
seem to have none at all, but at the same time there is documentation
for properties of things like Layer and Channel that are either
completely useless, or out of date.

Anyway here is the program that I propose be integrated into the python console:

--Sean Munkel
gimp-developer-list mailing list
gimp-developer-list gnome org

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]