Skip to content

lib/builtin.pm: Document that builtin functions have optimisations #22668

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 25, 2024
Merged

lib/builtin.pm: Document that builtin functions have optimisations #22668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion lib/builtin.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package builtin 0.015;
package builtin 0.016;

use v5.40;

Expand Down Expand Up @@ -106,6 +106,13 @@ The following bundles currently exist:
:5.40 true false weaken unweaken is_weak blessed refaddr reftype
ceil floor is_tainted trim indexed

=head2 Function Optimisations

There are a number of optimisations that apply to functions in the L<builtin>
package. If you replace or override these functions (such as by assignment
into glob references) the optimisations may not take effect. Do so with
caution.

Copy link
Contributor

@wolfsage wolfsage Oct 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"would be no longer be" -> "would no longer be".

"work out that intention" -> "work out the intention" (maybe?)

The whole thing feels very passive voice.

Maybe:

There are a number of optimisations that apply to functions in the L<builtin> package. If you
replace or override these functions, the optimisations may not take effect. Do so with caution.

Copy link
Contributor Author

@leonerd leonerd Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahyes, some better words.

=head1 FUNCTIONS

=head2 true
Expand Down