[13/14] Swap two sentences in the Pretty Printing API node

Message ID 20180908201417.13444-14-tom@tromey.com
State New, archived
Headers

Commit Message

Tom Tromey Sept. 8, 2018, 8:14 p.m. UTC
  I thought the start of the Pretty Printing API node read a bit
strangely.  This patch swaps the first two sentences, which seems
better.

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

	* python.texi (Pretty Printing API): Swap sentence order.
---
 gdb/doc/ChangeLog   | 4 ++++
 gdb/doc/python.texi | 5 ++---
 2 files changed, 6 insertions(+), 3 deletions(-)
  

Comments

Eli Zaretskii Sept. 8, 2018, 9:11 p.m. UTC | #1
> From: Tom Tromey <tom@tromey.com>
> Cc: Tom Tromey <tom@tromey.com>
> Date: Sat,  8 Sep 2018 14:14:16 -0600
> 
> I thought the start of the Pretty Printing API node read a bit
> strangely.  This patch swaps the first two sentences, which seems
> better.
> 
> gdb/doc/ChangeLog
> 2018-09-08  Tom Tromey  <tom@tromey.com>
> 
> 	* python.texi (Pretty Printing API): Swap sentence order.

OK, thanks.
  

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index e310c16c0a9..545e0c341de 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -1253,10 +1253,9 @@  Python module (@pxref{gdb.types}).
 @subsubsection Pretty Printing API
 @cindex python pretty printing api
 
-An example output is provided (@pxref{Pretty Printing}).
-
 A pretty-printer is just an object that holds a value and implements a
-specific interface, defined here.
+specific interface, defined here.  An example output is provided
+(@pxref{Pretty Printing}).
 
 @defun pretty_printer.children (self)
 @value{GDBN} will call this method on a pretty-printer to compute the