Re: [RFA][patch 1/9] Yet another respin of the patch with initial Python support

Eli Zaretskii
2008-07-26T19:26:05Z

> Date: Sat, 26 Jul 2008 14:29:57 -0400
> From: Daniel Jacobowitz <drow@false.org>
> Cc: tromey@redhat.com, bauerman@br.ibm.com, gdb-patches@sourceware.org
>
> On Sat, Jul 26, 2008 at 09:10:18PM +0300, Eli Zaretskii wrote:
> > > >> +@value{GDBN} introduces a new Python module, named @code{gdb}. All
> > > >> +methods and classes added by @value{GDBN} are placed in this module.
> > >
> > > Eli> OK, but what does this mean for whoever writes Python extensions for
> > > Eli> GDB? While at that, how about explaining why a command FOO is indexed
> > > Eli> as gdb.FOO?
> > >
> > > I thought it would be nice to index them both ways. Do you disagree?
> > >
> > > Python programmers know what the module stuff means. We don't have to
> > > explain that.
> >
> > Sorry, I disagree.
>
> What would you like explained?

Why it is important to the manual reader to know that there's a module
called `gdb', and that all methods and classes added by GDB are placed
in that module. Suppose I didn't know that--what would I be missing
as result, and what code would I get wrong?

> > > >> +Find the value of a @value{GDBN} setting.
> > >
> > > Eli> "find" or "display"? If the former, why the name is "show"?
> > >
> > > It mimics the CLI command name.
> >
> > ??? CLI commands that begin with "show" actually display the values.
> > This one does not, right?
>
> I suggest "get" parallel to "set", then.

Fine with me.