develooper Front page | perl.perl5.porters | Postings from March 2022

Include history in perldocs?

Thread Next
From:
Ovid via perl5-porters
Date:
March 4, 2022 17:30
Subject:
Include history in perldocs?
Message ID:
708482310.607777.1646415001305@mail.yahoo.com
Hi all,

This would be quite a bit of work, but I think it would be useful.

Often I type something like `perldoc $something`, `perldoc -f $something`, or `perldov -v '$^V` in the vain hope that the docs would have something like:

    =head1 Status

    Introduced: v5.6

    Changed: v5.10 changed from v-string to version object

(This is mentioned for $^V, but for many other things, it is not)

Obviously, many things would require different fields (experimental, for example).

I can never remember exactly when signatures were introduced or changed. Something similar for operators would also be useful.

I'm currently working on some code and I just can't remember when // was introduced. Other times I wonder about the `state` keyword. Or is a variable listed in `perlvar` still used, or relatively new?

It would be nice if the docs always provided the history of various Perl features to make it easier to write code and know if it can target 5.8 or not.

I'm unclear of the scope of this, but it would impact huge amounts of documentation and I don't know the best way of handling it. But for those writing portable code, or code targeting older versions of Perl, it would be a huge benefit.

Best,
Ovid
-- 
IT consulting, training, specializing in Perl, databases, and agile development
http://www.allaroundtheworld.fr/. 

Buy my book! - http://bit.ly/beginning_perl

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About