develooper Front page | perl.perl5.porters | Postings from April 2013

Any objections to moving the perlapi's "NOTE: this function is experimental"to the beginning of its entry

Thread Next
From:
Karl Williamson
Date:
April 30, 2013 14:33
Subject:
Any objections to moving the perlapi's "NOTE: this function is experimental"to the beginning of its entry
Message ID:
517FD61F.4070305@khwilliamson.com
Quite a few functions in the API are marked as experimental.  I think 
each should be highlighted by having that fact the first thing in the 
entry.  As an example, here's what a typical entry would look like:

av_create_and_push
        NOTE: this function is experimental and may change or be
        removed without notice.

        Push an SV onto the end of the array, creating the array if
        necessary.  A small internal helper function to remove a
        commonly duplicated idiom.

                void    av_create_and_push(AV **const avp,
                                           SV *const val)

Are there any objections?


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