Re: [PATCH 4/4] Documentation for python method InferiorThread.thread_handle

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Sat, 15 Sep 2018 22:18:47 -0700
> From: Kevin Buettner <kevinb@redhat.com>
> 
> +@defun InferiorThread.thread_handle (type)
> +Return the thread object's handle.  Since handles are generally opaque
> +objects, the type @var{type} is used to ensure that the correct amount

The phrase "type TYPE is used ..." is awkward.  I suggest to use just
"@var{type", as the name speaks for itself.

Actually, since we want to avoid passive tense, I'd rephrase

  Since various thread handles have different sizes, a Python program
  should supply a suitable @var{type} argument, to ensure @value{GDBN}
  allocates the correct amount of memory for the handle.  E.g., for
  thread handles associated with the @code{pthreads} library, you
  should use @code{gdb.lookup_type('pthread_t')} for @var{type}.

Thanks.