Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pod: nitpicks #14658

Closed
p5pRT opened this issue Apr 18, 2015 · 5 comments
Closed

pod: nitpicks #14658

p5pRT opened this issue Apr 18, 2015 · 5 comments

Comments

@p5pRT
Copy link

p5pRT commented Apr 18, 2015

Migrated from rt.perl.org#124335 (status was 'open')

Searchable as RT124335$

@p5pRT
Copy link
Author

p5pRT commented Apr 18, 2015

From @argrath

Pick some nits on pods.

@p5pRT
Copy link
Author

p5pRT commented Apr 18, 2015

From @argrath

nitpicks.diff
From dd565ac17f33ba03380b6a6c10cc394b57d23fa6 Mon Sep 17 00:00:00 2001
From: SHIRAKATA Kentaro <argrath@ub32.org>
Date: Sun, 19 Apr 2015 00:50:26 +0900
Subject: [PATCH] pod: nitpicks

---
 dist/ExtUtils-ParseXS/lib/perlxstut.pod | 2 +-
 pod/perldiag.pod                        | 2 +-
 pod/perlguts.pod                        | 2 +-
 pod/perllocale.pod                      | 4 ++--
 pod/perlvar.pod                         | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/dist/ExtUtils-ParseXS/lib/perlxstut.pod b/dist/ExtUtils-ParseXS/lib/perlxstut.pod
index a254688..f8a74dd 100644
--- a/dist/ExtUtils-ParseXS/lib/perlxstut.pod
+++ b/dist/ExtUtils-ParseXS/lib/perlxstut.pod
@@ -966,7 +966,7 @@ to have write permission into the directories where Perl is installed,
 or ask your system administrator to run the make for you.
 
 Alternately, you can specify the exact directory to place the extension's
-files by placing a "PREFIX=/destination/directory" after the make install.
+files by placing a "PREFIX=/destination/directory" after the make install
 (or in between the make and install if you have a brain-dead version of make).
 This can be very useful if you are building an extension that will eventually
 be distributed to multiple systems.  You can then just archive the files in
diff --git a/pod/perldiag.pod b/pod/perldiag.pod
index 14f1cac..3ef3ff5 100644
--- a/pod/perldiag.pod
+++ b/pod/perldiag.pod
@@ -1718,7 +1718,7 @@ workarounds.
 (F) The parser found inconsistencies either while attempting
 to define an overloaded constant, or when trying to find the
 character name specified in the C<\N{...}> escape.  Perhaps you
-forgot to load the corresponding L<overload> pragma?.
+forgot to load the corresponding L<overload> pragma?
 
 =item :const is experimental
 
diff --git a/pod/perlguts.pod b/pod/perlguts.pod
index 9761bad..5e38692 100644
--- a/pod/perlguts.pod
+++ b/pod/perlguts.pod
@@ -39,7 +39,7 @@ values that can be loaded: an integer value (IV), an unsigned integer
 value (UV), a double (NV), a string (PV), and another scalar (SV).
 ("PV" stands for "Pointer Value".  You might think that it is misnamed
 because it is described as pointing only to strings.  However, it is
-possible to have it point to other things  For example, it could point
+possible to have it point to other things.  For example, it could point
 to an array of UVs.  But,
 using it for non-strings requires care, as the underlying assumption of
 much of the internals is that PVs are just for strings.  Often, for
diff --git a/pod/perllocale.pod b/pod/perllocale.pod
index 5482888..701b422 100644
--- a/pod/perllocale.pod
+++ b/pod/perllocale.pod
@@ -1251,7 +1251,7 @@ priority than C<LC_ALL>.  Moreover, it's not a single value but
 instead a "path" (":"-separated list) of I<languages> (not locales).
 See the GNU C<gettext> library documentation for more information.
 
-=item C<LC_CTYPE>.
+=item C<LC_CTYPE>
 
 In the absence of C<LC_ALL>, C<LC_CTYPE> chooses the character type
 locale.  In the absence of both C<LC_ALL> and C<LC_CTYPE>, C<LANG>
@@ -1285,7 +1285,7 @@ C<LANG> chooses the date and time formatting locale.
 
 C<LANG> is the "catch-all" locale environment variable. If it is set, it
 is used as the last resort after the overall C<LC_ALL> and the
-category-specific C<LC_I<foo>>
+category-specific C<LC_I<foo>>.
 
 =back
 
diff --git a/pod/perlvar.pod b/pod/perlvar.pod
index e14d844..ca89a62 100644
--- a/pod/perlvar.pod
+++ b/pod/perlvar.pod
@@ -1413,7 +1413,7 @@ set, you'll get the record back in pieces.  Trying to set the record
 size to zero or less is deprecated and will cause $/ to have the value
 of "undef", which will cause reading in the (rest of the) whole file.
 
-As of 5.19.9 setting C<$/> to any other form of reference will throw a
+As of 5.20.0 setting C<$/> to any other form of reference will throw a
 fatal exception. This is in preparation for supporting new ways to set
 C<$/> in the future.
 
-- 
1.9.5.msysgit.0

@p5pRT
Copy link
Author

p5pRT commented Apr 18, 2015

From @jkeenan

On Sat Apr 18 08​:52​:50 2015, argrath@​ub32.org wrote​:

Pick some nits on pods.

Thank you very much for your patch submission. In commit 3ee1a09, I have applied to blead your revisions to 4 of the 5 files referenced in your patch.

I did not apply this change to pod/perlvar.pod​:

#####

Inline Patch
diff --git a/pod/perlvar.pod b/pod/perlvar.pod
index e14d844..ca89a62 100644
--- a/pod/perlvar.pod
+++ b/pod/perlvar.pod
@@ -1413,7 +1413,7 @@ set, you'll get the record back in pieces.  Trying to set the record
 size to zero or less is deprecated and will cause $/ to have the value
 of "undef", which will cause reading in the (rest of the) whole file.

-As of 5.19.9 setting C<$/> to any other form of reference will throw a
+As of 5.20.0 setting C<$/> to any other form of reference will throw a
 fatal exception. This is in preparation for supporting new ways to set
 C<$/> in the future.
#####

I did not apply it because here, unlike the other 4 files, you are materially changing to content of the documentation. I examined the commit where this section first appeared, and since the author refers specifically to 5.19.9 in 3 locations, I feel the documentation is correct as is. I believe it is legitimate for our documentation to refer to a monthly developmental release as the place where a feature was introduced, modified or removed.

Thank you very much.
Jim Keenan
--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Apr 18, 2015

The RT System itself - Status changed from 'new' to 'open'

@jkeenan
Copy link
Contributor

jkeenan commented Oct 29, 2023

There has been no further discussion in this ticket or complaint about the patches applied eight years ago. Closing now.

@jkeenan jkeenan closed this as completed Oct 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants