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

Inconsistent "possibly inferred" link text descriptions in perlpodspec.pod #11754

Closed
p5pRT opened this issue Nov 18, 2011 · 7 comments
Closed

Comments

@p5pRT
Copy link

p5pRT commented Nov 18, 2011

Migrated from rt.perl.org#104000 (status was 'rejected')

Searchable as RT104000$

@p5pRT
Copy link
Author

p5pRT commented Nov 18, 2011

From rwstauner@cpan.org

The "Second" item ("possibly inferred link text") in "About L<...>
Codes" seems inconsistent in the examples.
The description paragraph sounds to me as if the second item should be
inferred regardless of any alternate text.

These two examples link to the same pod and section
but have different "inferred text"​:

 L<Perlport's section on NL's|perlport/Newlines>
   =>  "Perlport's section on NL's",   # link text
       "Perlport's section on NL's",   # possibly inferred link text
       "perlport",                     # name
       "Newlines",                     # section
       'pod',                          # what sort of link
       "Perlport's section on NL's|perlport/Newlines" # orig. content

  L<perlport/Newlines>
    =>  undef,                          # link text
        '"Newlines" in perlport',       # possibly inferred link text
        "perlport",                     # name
        "Newlines",                     # section
        'pod',                          # what sort of link
        "perlport/Newlines"             # original content

I originally intended to report the inferred text of this example as incorrect​:

  L<Perl.org|http​://www.perl.org/>
    =>  "Perl.org",                     # link text
        "http​://www.perl.org/",         # possibly inferred link text
        "http​://www.perl.org/",         # name
        undef,                          # section
        'url',                          # what sort of link
        "Perl.org|http​://www.perl.org/" # original content

but after re-reading the description I believe that example to be
accurate and the former incorrect.
Do you agree?  Do I understand the description correctly?

Thanks!

@p5pRT
Copy link
Author

p5pRT commented Nov 18, 2011

From rwstauner@cpan.org

perlpodspec-inferred-text.patch
diff --git a/pod/perlpodspec.pod b/pod/perlpodspec.pod
index dbe0539..8e1d062 100644
--- a/pod/perlpodspec.pod
+++ b/pod/perlpodspec.pod
@@ -1187,7 +1187,7 @@ For example:
 
   L<Perlport's section on NL's|perlport/Newlines>
     =>  "Perlport's section on NL's",   # link text
-        "Perlport's section on NL's",   # possibly inferred link text
+        '"Newlines" in perlport',       # possibly inferred link text
         "perlport",                     # name
         "Newlines",                     # section
         'pod',                          # what sort of link

@p5pRT
Copy link
Author

p5pRT commented Nov 18, 2011

From rwstauner@cpan.org

I forgot to add that I noticed this when comparing the output of
Pod​::ParseLink to the examples in perlpodspec.

The output of parselink matches the examples except for the last one​:

  DB<27> x parselink 'Perl.org|http​://www.perl.org/'
0  'Perl.org'
1  'Perl.org'
2  'http​://www.perl.org/'
3  undef
4  'url'

So either perlpodspec is wrong, or Pod​::ParseLink is wrong.
I believe Pod​::ParseLink is incorrect since it is duplicating the
actual text as the "inferred" text.

@p5pRT
Copy link
Author

p5pRT commented Nov 18, 2011

From rwstauner@cpan.org

cross-reference​:
podlators/Pod​::ParseLink
https://rt.cpan.org/Ticket/Display.html?id=72536

@p5pRT
Copy link
Author

p5pRT commented Nov 18, 2011

rwstauner@cpan.org - Status changed from 'new' to 'open'

@p5pRT
Copy link
Author

p5pRT commented Aug 10, 2013

From @jkeenan

On Fri Nov 18 11​:42​:49 2011, rwstauner wrote​:

cross-reference​:
podlators/Pod​::ParseLink
https://rt.cpan.org/Ticket/Display.html?id=72536

Since this is being tracked in the podlators bug queue, we don't need to
keep this RT open. Closing.

@p5pRT
Copy link
Author

p5pRT commented Aug 10, 2013

@jkeenan - Status changed from 'open' to 'rejected'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant