Skip to content

[doc] Some tutorials have drifted into the following section #17710

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

Open
jidanni opened this issue Apr 11, 2020 · 2 comments
Open

[doc] Some tutorials have drifted into the following section #17710

jidanni opened this issue Apr 11, 2020 · 2 comments
Assignees

Comments

@jidanni
Copy link
Member

jidanni commented Apr 11, 2020

Here we see some tutorials have leaked out of the tutorials section,
ending up in the next ("Reference Manual") section.

$ man perl|col -b|perl -wlne 'next unless /[Tt]utor|Reference/ && (length) < 66; print;'
   Tutorials
           perlretut           Perl regular expressions tutorial
           perlootut           Perl OO tutorial for beginners
           perldebtut          Perl debugging tutorial
   Reference Manual
             perlopentut       Perl open() tutorial
             perlpacktut       Perl pack() and unpack() tutorial
           perlthrtut          Perl threads tutorial
           perlunitut          Perl Unicode tutorial
           perlxstut           Perl XS tutorial

Therefore, the "perl" man page needs fixing.

@richardleach
Copy link
Contributor

That's a good point. It (/pod/perl.pod) has been like that for over a decade, but if it's deliberate then the rationale for which tutorials go into what section doesn't seem obvious.

This one is an outlier:
perlxstut Perl XS tutorial
It's actually in the Internals and C Language Interface section, not the Reference Manual section. It should stay where it is IMHO.

Whitespace in /pod/perl.pod looks out of whack. Besides some entries being curiously indented (e.g. perlopentut in the previous post), there's a mixture of tabs and spaces in that file which is resulting in incorrect indentation when viewed via GitHub.

I'm happy to submit PRs to:

  • change all tabs to spaces - if it's safe to do so (I don't know the details of e.g. man page generation)
  • move perlopentut, perlpacktut, perlthrtut, perlunitut to the Tutorials section

Just need guidance from people who've been around longer as to whether those are correct changes...

@khwilliamson
Copy link
Contributor

@richardleach now you've been around long enough to have good opinions. spaces are better than tabs, and I think the other items would be better in Tutorials as @jidanni suggests.

@richardleach richardleach self-assigned this May 4, 2025
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

4 participants