From: Eli Zaretskii <eliz@gnu.org>
To: Maxim Bublis <satori@yandex-team.ru>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 3/3] gdb/doc/python.texi: documented gdb.SYMBOL_LOC_LABEL. Added notion on possible exception thrown from symbol object .value() method
Date: Tue, 04 Mar 2014 16:53:00 -0000 [thread overview]
Message-ID: <83eh2hsy77.fsf@gnu.org> (raw)
In-Reply-To: <1393929360-31299-4-git-send-email-satori@yandex-team.ru>
> From: Maxim Bublis <satori@yandex-team.ru>
> Cc: Maxim Bublis <satori@yandex-team.ru>
> Date: Tue, 4 Mar 2014 14:36:00 +0400
>
> +2014-03-04 Maxim Bublis <satori@yandex-team.ru>
> +
> + * gdb/doc/python.texi (Symbols In Python): Document gdb.SYMBOL_LOC_LABEL
> + address class. Added notion on possible exception thrown from .value()
^^
Two spaces between sentences, please. Also, please don't attach "()"
to function and method name to signal they are function, that's
against GNU Coding Standards (it looks like a call to a function with
no arguments, which is not what you want to say).
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -3544,7 +3544,10 @@ functions, this computes the address of the function, cast to the
> appropriate type. If the symbol requires a frame in order to compute
> its value, then @var{frame} must be given. If @var{frame} is not
> given, or if @var{frame} is invalid, then this method will throw an
> -exception.
> +exception. For symbols with some address classes it is not possible
> +to compute value (eg. @code{gdb.SYMBOL_LOC_TYPEDEF} or
> +@code{gdb.SYMBOL_LOC_LABEL}), in this case exception will
> +be thrown.
Please try to minimize the use of passive tense, it makes the text
longer and slightly less clear. In this case, I suggest to rephrase:
This method will also throw an exception for symbols for which it is
not possible to compute the value, such as
@code{gdb.SYMBOL_LOC_TYPEDEF} or @code{gdb.SYMBOL_LOC_LABEL}.
The documentation patch is OK with those changes.
I have a question regarding the last part: is it wise to throw an
exception when a symbol has no value? how about returning None
instead?
next prev parent reply other threads:[~2014-03-04 16:53 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-04 10:36 [PATCH 0/3] Fixed abortion using Python API for label symbol object Maxim Bublis
2014-03-04 10:37 ` [PATCH 3/3] gdb/doc/python.texi: documented gdb.SYMBOL_LOC_LABEL. Added notion on possible exception thrown from symbol object .value() method Maxim Bublis
2014-03-04 16:53 ` Eli Zaretskii [this message]
2014-03-05 13:34 ` Maxim Bublis
2014-03-05 13:41 ` [PATCH v2 3/3] gdb/doc/python.texi: documented gdb.SYMBOL_LOC_LABEL, added notion on possible exceptions thrown from symbol object value method Maxim Bublis
2014-03-05 17:12 ` Eli Zaretskii
2014-03-04 10:37 ` [PATCH 1/3] gdb/testsuite/gdb.python: Added testcase for .value() method Maxim Bublis
2014-03-05 13:41 ` [PATCH v2 1/3] gdb/testsuite/gdb.python: Added testcase for value method Maxim Bublis
[not found] ` <1394026864-4691-2-git-send-email-satori@yandex-team.ru>
2014-04-14 7:41 ` [PATCH v2 2/3] gdb/python: raise TypeError instead of abort on calling value method for label symbol object Phil Muldoon
2014-04-16 17:20 ` Maxim Bublis
2014-04-17 12:44 ` Maxim Bublis
2014-03-04 10:37 ` [PATCH 2/3] gdb/python: raise TypeError instead of abort() on calling .value() " Maxim Bublis
2014-03-04 17:57 ` Phil Muldoon
[not found] ` <07E7B14B-748D-4CF7-A8AD-623AF5D6E701@yandex-team.ru>
2014-03-06 8:37 ` Phil Muldoon
2014-03-25 16:51 ` [PATCH 0/3] Fixed abortion using Python API " Maxim Bublis
2014-03-25 19:51 ` Phil Muldoon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83eh2hsy77.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=satori@yandex-team.ru \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox