GNU bug report logs - #15529
paste documentation tweak

Previous Next

Package: coreutils;

Reported by: karl <at> freefriends.org (Karl Berry)

Date: Fri, 4 Oct 2013 23:35:01 UTC

Severity: normal

Done: Pádraig Brady <P <at> draigBrady.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Pádraig Brady <P <at> draigBrady.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#15529: closed (paste documentation tweak)
Date: Sat, 05 Oct 2013 02:54:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Sat, 05 Oct 2013 03:53:46 +0100
with message-id <524F7F3A.4000208 <at> draigBrady.com>
and subject line Re: bug#15529: paste documentation tweak
has caused the debbugs.gnu.org bug report #15529,
regarding paste documentation tweak
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
15529: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15529
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: karl <at> freefriends.org (Karl Berry)
To: bug-coreutils <at> gnu.org
Subject: paste documentation tweak
Date: Fri, 4 Oct 2013 23:34:09 GMT
I suggest the following small change to the paste node in the
documentation.  Sorry I don't have the git-fu to give you the patch in
that format.

2013-10-04  Karl Berry  <karl <at> gnu.org>

	* coreutils.texi (paste invocation): Move synopsis to
	above existing example; add second example for standard input.

--- ORIG/coreutils.texi	2013-02-11 01:37:28.000000000 -0800
+++ coreutils.texi	2013-10-04 16:31:13.602509258 -0700
@@ -5963,3 +5963,9 @@
 
-For example:
+Synopsis:
+
+@example
+paste [@var{option}]@dots{} [@var{file}]@dots{}
+@end example
+
+Example:
 
@@ -5979,8 +5985,2 @@
 
-Synopsis:
-
-@example
-paste [@var{option}]@dots{} [@var{file}]@dots{}
-@end example
-
 The program accepts the following options.  Also see @ref{Common options}.
@@ -6019,2 +6019,10 @@
 
+Here is another example, to paste together consecutive lines from
+standard input, with a delimiter of a space:
+
+@example
+$ cat num2 | paste -d"" - -
+1 2
+@end example
+
 @exitstatus

Diff finished at Fri Oct  4 16:31:15


[Message part 3 (message/rfc822, inline)]
From: Pádraig Brady <P <at> draigBrady.com>
To: Karl Berry <karl <at> freefriends.org>
Cc: 15529-done <at> debbugs.gnu.org
Subject: Re: bug#15529: paste documentation tweak
Date: Sat, 05 Oct 2013 03:53:46 +0100
On 10/05/2013 12:34 AM, Karl Berry wrote:
> I suggest the following small change to the paste node in the
> documentation.  Sorry I don't have the git-fu to give you the patch in
> that format.
> 
> 2013-10-04  Karl Berry  <karl <at> gnu.org>
> 
> 	* coreutils.texi (paste invocation): Move synopsis to
> 	above existing example; add second example for standard input.
> 
> --- ORIG/coreutils.texi	2013-02-11 01:37:28.000000000 -0800
> +++ coreutils.texi	2013-10-04 16:31:13.602509258 -0700
> @@ -5963,3 +5963,9 @@
>  
> -For example:
> +Synopsis:
> +
> +@example
> +paste [@var{option}]@dots{} [@var{file}]@dots{}
> +@end example
> +
> +Example:
>  
> @@ -5979,8 +5985,2 @@
>  
> -Synopsis:
> -
> -@example
> -paste [@var{option}]@dots{} [@var{file}]@dots{}
> -@end example
> -
>  The program accepts the following options.  Also see @ref{Common options}.
> @@ -6019,2 +6019,10 @@
>  
> +Here is another example, to paste together consecutive lines from
> +standard input, with a delimiter of a space:
> +
> +@example
> +$ cat num2 | paste -d"" - -
> +1 2
> +@end example
> +
>  @exitstatus
> 
> Diff finished at Fri Oct  4 16:31:15

Yes the `paste` examples could be better.
This might be a bit more instructive:

$ seq 4 | paste -d ' ' - -
1 2
3 4

Also this might be good for comparison:

$ seq 4 | paste -s -d ' '
1 2 3 4

I'll push something like that in the morning.

thanks,
Pádraig.


This bug report was last modified 11 years and 236 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.