[11/14] Small typo fix in Basic Python node

Message ID 20180908201417.13444-12-tom@tromey.com
State New
Headers show
Series
  • Many small Python documentation fixes
Related show

Commit Message

Tom Tromey Sept. 8, 2018, 8:14 p.m.
I noticed that the decode_line documentation did not have parens
around the argument:

 -- Function: gdb.decode_line [expression]

This patch fixes this oversight.

gdb/doc/ChangeLog
2018-09-08  Tom Tromey  <tom@tromey.com>

	* python.texi (Basic Python): Parenthesize argument to
	decode_line.
---
 gdb/doc/ChangeLog   | 5 +++++
 gdb/doc/python.texi | 2 +-
 2 files changed, 6 insertions(+), 1 deletion(-)

-- 
2.13.6

Comments

Eli Zaretskii Sept. 8, 2018, 9:08 p.m. | #1
> From: Tom Tromey <tom@tromey.com>

> Cc: Tom Tromey <tom@tromey.com>

> Date: Sat,  8 Sep 2018 14:14:14 -0600

> 

> I noticed that the decode_line documentation did not have parens

> around the argument:

> 

>  -- Function: gdb.decode_line [expression]

> 

> This patch fixes this oversight.


Thanks, this is obviously OK.

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index eb4c3a53781..6eccc2b1154 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -448,7 +448,7 @@  as a string, or @code{None}.
 @end defun
 
 @findex gdb.decode_line 
-@defun gdb.decode_line @r{[}expression@r{]}
+@defun gdb.decode_line (@r{[}expression@r{]})
 Return locations of the line specified by @var{expression}, or of the
 current line if no argument was given.  This function returns a Python
 tuple containing two elements.  The first element contains a string