Navigation Menu

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

my/local/state documentation doesn't belong in perlsub #17153

Open
p5pRT opened this issue Sep 10, 2019 · 4 comments
Open

my/local/state documentation doesn't belong in perlsub #17153

p5pRT opened this issue Sep 10, 2019 · 4 comments

Comments

@p5pRT
Copy link

p5pRT commented Sep 10, 2019

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

Searchable as RT134435$

@p5pRT
Copy link
Author

p5pRT commented Sep 10, 2019

From @Grinnz

Currently, the perlfunc entries for my, local, and state point to
documentation in perlsub which appears to be the in-depth documentation for
these keywords. Notably, our is instead detailed directly in its perlfunc
entry. I don't think it makes much sense to document these keywords in
perlfunc, since their use is largely unrelated to subroutines in any
meaningful way. Some other options may be documenting them in their
perlfunc entries more fully like our, or documenting them all (including
our as well) somewhere else like perlsyn or perldata. I would be happy to
work on a patch if there is any consensus on direction.

-Dan

(Perl)

@p5pRT
Copy link
Author

p5pRT commented Sep 10, 2019

From @Grinnz

On Tue, 10 Sep 2019 13​:11​:15 -0700, grinnz@​gmail.com wrote​:

I don't think it makes much sense to document these keywords in
perlfunc,

This of course should have said "in perlsub".

-Dan

@p5pRT
Copy link
Author

p5pRT commented Oct 6, 2019

From @jkeenan

On Tue, 10 Sep 2019 20​:11​:15 GMT, grinnz@​gmail.com wrote​:

Currently, the perlfunc entries for my, local, and state point to
documentation in perlsub which appears to be the in-depth documentation for
these keywords. Notably, our is instead detailed directly in its perlfunc
entry. I don't think it makes much sense to document these keywords in
perlfunc, since their use is largely unrelated to subroutines in any
meaningful way. Some other options may be documenting them in their
perlfunc entries more fully like our, or documenting them all (including
our as well) somewhere else like perlsyn or perldata. I would be happy to
work on a patch if there is any consensus on direction.

-Dan

(Perl)

FWIW, the commit which brought this documentation into pod/perlsub.pod was the 44th to commit to Perl 5, back in 1995. So we've lived with this positioning of the documentation for a long time.

Thank you very much.

--
James E Keenan (jkeenan@​cpan.org)

@p5pRT
Copy link
Author

p5pRT commented Oct 6, 2019

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

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

2 participants