Python 3 vs. @code{Python} 3 in python.texi

Python 3 vs. @code{Python} 3 in python.texi

[Yao Qi]

Hi Eli,
Which one do we use in sentence "In XXX, the return
value is a @code{memoryview} object.", "Python 3" or
"@code{Python} 3"?
https://sourceware.org/ml/gdb-patches/2017-03/msg00039.html

We use "@code{Python} 3" for Inferior.read_memory,
....
@code{Inferior.write_memory} function.  In @code{Python} 3, the return
value is a @code{memoryview} object.

so I suggested that we need to use "@code{Python} 3" for
consistency, but Tim believes "Python 3" should be used,
because "@code{python} is used when the actual "python" command
in GDB is meant, not the name of the language per-se."

-- 
Yao (齐尧)

Re: Python 3 vs. @code{Python} 3 in python.texi

[Eli Zaretskii]

> From: Yao Qi <qiyaoltc@gmail.com>
> Date: Mon, 20 Mar 2017 14:36:42 +0000
> Cc: Tim Wiederhake <tim.wiederhake@intel.com>, 
> 	"gdb-patches@sourceware.org" <gdb-patches@sourceware.org>
> 
> Hi Eli,
> Which one do we use in sentence "In XXX, the return
> value is a @code{memoryview} object.", "Python 3" or
> "@code{Python} 3"?
> https://sourceware.org/ml/gdb-patches/2017-03/msg00039.html
> 
> We use "@code{Python} 3" for Inferior.read_memory,
> ....
> @code{Inferior.write_memory} function.  In @code{Python} 3, the return
> value is a @code{memoryview} object.
> 
> so I suggested that we need to use "@code{Python} 3" for
> consistency, but Tim believes "Python 3" should be used,
> because "@code{python} is used when the actual "python" command
> in GDB is meant, not the name of the language per-se."

There's no reason to use @code for Python the name of a programming
language.  If we do that in the manual, that is a mistake.

For 'python' the program, we should use @command{python}, not @code.

[PATCH] Remove @code for python

[Yao Qi]

There's no reason to use @code for Python the name of a programming
language.

gdb/doc:

2017-03-22  Yao Qi  <yao.qi@linaro.org>

	* python.texi (Inferiors In Python): Remove @code from Python.
---
 gdb/doc/ChangeLog   | 4 ++++
 gdb/doc/python.texi | 2 +-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 8253cbe..5eb3a6c 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@
+2017-03-22  Yao Qi  <yao.qi@linaro.org>
+
+	* python.texi (Inferiors In Python): Remove @code from Python.
+
 2017-03-21  Tim Wiederhake  <tim.wiederhake@intel.com>
 
 	* python.texi (Recordings In Python): Document return type of
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 1fb8b25..ce5810e 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2760,7 +2760,7 @@ return an empty tuple.
 Read @var{length} addressable memory units from the inferior, starting at
 @var{address}.  Returns a buffer object, which behaves much like an array
 or a string.  It can be modified and given to the
-@code{Inferior.write_memory} function.  In @code{Python} 3, the return
+@code{Inferior.write_memory} function.  In Python 3, the return
 value is a @code{memoryview} object.
 @end defun
 
-- 
1.9.1

Re: [PATCH] Remove @code for python

[Eli Zaretskii]

> From: Yao Qi <qiyaoltc@gmail.com>
> Date: Wed, 22 Mar 2017 12:43:46 +0000
> 
> There's no reason to use @code for Python the name of a programming
> language.
> 
> gdb/doc:
> 
> 2017-03-22  Yao Qi  <yao.qi@linaro.org>
> 
> 	* python.texi (Inferiors In Python): Remove @code from Python.

Thanks, this is OK.