Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Simon Marchi <simon.marchi@efficios.com>
To: gdb-patches@sourceware.org
Cc: Kevin Buettner <kevinb@redhat.com>,	Eli Zaretskii <eliz@gnu.org>,
	Simon Marchi <simon.marchi@efficios.com>
Subject: [PATCH] Small fix to gdb.Value constructor doc
Date: Tue, 05 Mar 2019 17:06:00 -0000	[thread overview]
Message-ID: <20190305170544.23216-1-simon.marchi@efficios.com> (raw)

The synopsis of the two-parameters form of the gdb.Value constructor is
currently shown as

    Value.__init__ (val, [, type ])

in the documentation.

First, there is an extra comma, which I think we can remove in any
case.

Then, since the type parameter is not optional, I would not put in
between square brackets.  Those usually indicate that something is
optional.

With this patch, it appears as:

    Value.__init__ (val, type)

gdb/doc/ChangeLog:

	* python.texi (Values From Inferior): Change synopsys of the
	second form of Value.__init__.
---
 gdb/doc/python.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 7f6f52c4df..aaaa4ff1a6 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -735,7 +735,7 @@ its result is used.
 @end table
 @end defun
 
-@defun Value.__init__ (@var{val}, @r{[}, type @r{]})
+@defun Value.__init__ (@var{val}, type)
 This second form of the @code{gdb.Value} constructor returns a
 @code{gdb.Value} of type @var{type} where the value contents are taken
 from the Python buffer object specified by @var{val}.  The number of
-- 
2.21.0


             reply	other threads:[~2019-03-05 17:06 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-05 17:06 Simon Marchi [this message]
2019-03-05 18:52 ` Kevin Buettner
     [not found] ` <83sgw1cjt3.fsf@gnu.org>
2019-03-05 19:02   ` Simon Marchi

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=20190305170544.23216-1-simon.marchi@efficios.com \
    --to=simon.marchi@efficios.com \
    --cc=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=kevinb@redhat.com \
    /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