Re: [patch][doc] PR python/10781

Eli Zaretskii
2009-10-16T18:44:41Z

> From: Tom Tromey <tromey@redhat.com>
> Cc: Phil Muldoon <pmuldoon@redhat.com>, gdb-patches@sourceware.org
> Date: Fri, 16 Oct 2009 12:07:01 -0600
>
> >>>>> "Eli" == Eli Zaretskii <eliz@gnu.org> writes:
>
> >> +Cast the @code{gdb.Value} to the type represented by @var{type}, and
> Eli> ^^^
> Eli> Please remove this "the".
>
> Removing the "the" makes this read strangely.
> gdb.Value is a class, the "the" indicates that it is an instance which is
> cast.

Then how about "Cast an instance of @code{gdb.Value} ..."?

> >> +return a new @code{gdb.Value}. @var{type} must be a @code{gdb.Type}
> >> +object.
>
> Eli> If TYPE is an object, then it probably isn't a good idea to call it
> Eli> TYPE. Why not OBJECT?
>
> I think it is generally preferable to name parameters according to their
> use.

No, they should be named according to their essence, i.e. what they
are.

> "object" is not specific enough.

I'm open to other suggestions.

> Eli> Anyway, what does it mean "the type represented by TYPE"? How can a
> Eli> type be "represented"? Did you perhaps mean "the type of TYPE"?
>
> gdb.Type represents a type in the inferior.

Sorry, I still don't understand.