Skip to content

Commit 35df3e1

Browse files
committed
Eliminates another category, refs #1410
And chekcs that #1358 is well closed.
1 parent 32e15f3 commit 35df3e1

File tree

1 file changed

+41
-33
lines changed

1 file changed

+41
-33
lines changed

doc/Language/variables.pod6

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,6 @@ L<Sub|/type/Sub> attached to the current routine. It does support the method
11021102
C<.name> to obtain the name of the called routine, as well as C<.signature> and
11031103
others method related to C<Sub>:
11041104
1105-
11061105
sub awesome-sub { say &?ROUTINE.name }
11071106
awesome-sub # OUTPUT: awesome-sub
11081107
@@ -1117,7 +1116,7 @@ sub do-work {
11171116
do-work;
11181117
=end code
11191118
1120-
=head3 X<&?BLOCK|&?BLOCK>
1119+
=head3 X<&?BLOCK>
11211120
11221121
The special compile variable C<?&BLOCK> behaves similarly to
11231122
C<?&ROUTINE> but it allows to introspect a single block of code.
@@ -1140,26 +1139,25 @@ for '.' {
11401139
11411140
11421141
All dynamically scoped variables have the C<*> twigil, and their name is written
1143-
uppercase.
1142+
in uppercase.
11441143
11451144
X<|$*ARGFILES>X<|@*ARGS>
11461145
=head3 Argument related variables
11471146
1148-
=item C<$*ARGFILES>
1149-
An L<IO::ArgFiles> (an empty subclass of L<IO::CatHandle>)
1150-
that uses C<@*ARGS> as source files, if
1151-
it contains any files, or C<$*IN> otherwise. When C<$*IN>
1152-
is used, its C<:nl-in>, C<:chomp>, C<:encoding>,
1153-
and C<:bin> will be set on the L<IO::ArgFiles> object.
1147+
=item C<$*ARGFILES> An L<IO::ArgFiles> (an empty subclass of L<IO::CatHandle>)
1148+
that uses C<@*ARGS> as source files, if it contains any files, or C<$*IN>
1149+
otherwise. When C<$*IN> is used, its C<:nl-in>, C<:chomp>, C<:encoding>, and
1150+
C<:bin> will be set on the L<IO::ArgFiles> object.
11541151
11551152
=item C<@*ARGS>
11561153
Arguments from the command line.
11571154
11581155
X<|$*IN>X<|$*OUT>X<|$*ERR>
11591156
=head3 Special File Handles: STDIN, STDOUT and STDERR
11601157
1161-
For more information about special filehandles please see also
1162-
the L<Input and Output|/language/io> page and the L<IO::Special> class. L<IO::Handle> contains several examples of using C<$*IN> for reading standard input.
1158+
For more information about special filehandles please see also the L<Input and
1159+
Output|/language/io> page and the L<IO::Special> class. L<IO::Handle> contains
1160+
several examples of using C<$*IN> for reading standard input.
11631161
11641162
11651163
=item C<$*IN>
@@ -1233,10 +1231,9 @@ X<|$*PROGRAM>
12331231
location (in the form of an C<IO::Path> object) of the Perl program being executed;
12341232
12351233
X<|$*EXIT>
1236-
=item C<&*EXIT>
1237-
code that will be executed when doing an exit(). Intended
1238-
to be used in situations where Perl 6 is embedded in
1239-
another language runtime (such as Inline::Perl6 in Perl 5);
1234+
=item C<&*EXIT> code that will be executed when doing an exit(). Intended to
1235+
be used in situations where Perl 6 is embedded in another language runtime
1236+
(such as Inline::Perl6 in Perl 5);
12401237
12411238
X<|$*EXECUTABLE>
12421239
=item C<$*EXECUTABLE>
@@ -1258,23 +1255,23 @@ C<sub MAIN> and C<sub USAGE>. The variable is I<read-only>;
12581255
X<|$*USER>
12591256
=item C<$*USER>
12601257
the user that is running the program. It's an object
1261-
that evaluates to "username (uid)". It will evaluate
1258+
that evaluates to C<username (uid)>. It will evaluate
12621259
to the username only if treated as a string and the
12631260
numeric user id if treated as a number;
12641261
12651262
X<|$*GROUP>
12661263
=item C<$*GROUP>
12671264
the primary group of the user who is running the program.
1268-
It's an object that evaluates to "groupname (gid)".
1265+
It's an object that evaluates to C<groupname (gid)>.
12691266
It will evaluate to the groupname only if treated as a
12701267
string and the numeric group id if treated as a number;
12711268
12721269
X<|$*HOME>
12731270
=item C<$*HOME>
12741271
an L<IO::Path> object representing the "home directory"
12751272
of the user that is running the program. Uses
1276-
C«%*ENV<HOME>» if set. On Windows, uses
1277-
C«%*ENV<HOMEDRIVE> ~ %*ENV<HOMEPATH>». If the
1273+
C«%*ENV<HOME>» if set. On Windows, uses
1274+
C«%*ENV<HOMEDRIVE> ~ %*ENV<HOMEPATH>». If the
12781275
home directory cannot be determined, it will be L<Any>;
12791276
12801277
X<|$*SPEC>
@@ -1299,18 +1296,19 @@ X<|$*SCHEDULER>
12991296
a L<ThreadPoolScheduler> object representing the current default scheduler (see note below);
13001297
13011298
X<|$*SAMPLER>
1302-
=item C<$*SAMPLER>
1303-
the current L<Telemetry::Sampler> used for making
1304-
snapshots of system state. Only available if
1305-
L<Telemetry> has been loaded.
1299+
=item C<$*SAMPLER>: the current L<Telemetry::Sampler> used for
1300+
making snapshots of system state. Only available if L<Telemetry> has been
1301+
loaded.
13061302
13071303
13081304
Note on usage of C<$*SCHEDULER>:
13091305
1310-
For the current (2018.04) Rakudo, by default this imposes a maximum of 64 threads on the methods
1311-
C<.hyper>, C<.race> and other thread-pool classes that use that scheduler such as C<Promise>s or C<Supplie>s. To change the maximum number of threads, you can either set the
1312-
environment variable C<RAKUDO_MAX_THREADS> before running perl6 or create a scoped copy
1313-
with the default changed before using them:
1306+
For the current (2018.04) Rakudo, by default this imposes a maximum of 64
1307+
threads on the methods C<.hyper>, C<.race> and other thread-pool classes that
1308+
use that scheduler such as C<Promise>s or C<Supplie>s. To change the maximum
1309+
number of threads, you can either set the environment variable
1310+
C<RAKUDO_MAX_THREADS> before running perl6 or create a scoped copy with the
1311+
default changed before using them:
13141312
13151313
my $*SCHEDULER = ThreadPoolScheduler.new( max_threads => 128 );
13161314
@@ -1322,17 +1320,27 @@ It is helpful to know our naming conventions in order to understand what codes
13221320
do directly. However, there is not yet a conventions list covering anywhere.
13231321
Still we list several conventions that are widely held.
13241322
1325-
=item1 Subs and methods from the built-ins library try to have single-word names when a good one could be found. In cases where there are two or more words making up a name, they are separated by a "-".
1323+
=item1 Subs and methods from the built-ins library try to have single-word names
1324+
when a good one could be found. In cases where there are two or more words
1325+
making up a name, they are separated by a "-".
13261326
1327-
=item1 Compounds are treated as a single word, thus C<substr>, C<subbuf>, and C<deepmap> (just like we write "starfish", not "star fish" in English).
1327+
=item1 Compounds are treated as a single word, thus C<substr>, C<subbuf>, and
1328+
C<deepmap> (just like we write "starfish", not "star fish" in English).
13281329
1329-
=item1 Subs and methods that are automatically called for you at special times are written in uppercase. This includes the C<MAIN> sub, the C<AT-POS> and related methods for implementing container types, along with C<BUILD> and C<DESTROY>.
1330+
=item1 Subs and methods that are automatically called for you at special times
1331+
are written in uppercase. This includes the C<MAIN> sub, the C<AT-POS> and
1332+
related methods for implementing container types, along with C<BUILD> and
1333+
C<DESTROY>.
13301334
1331-
=item1 Type names are camel case, except for native types, which are lowercase. For the exception, you can remember it by: they are stored in a more compact way, so they names look smaller too.
1335+
=item1 Type names are camel case, except for native types, which are lowercase.
1336+
For the exception, you can remember it by: they are stored in a more compact
1337+
way, so they names look smaller too.
13321338
1333-
=item1 Built-in dynamic variables and compile-time variables are always uppercase, such like C<$*OUT>, C<$?FILE>.
1339+
=item1 Built-in dynamic variables and compile-time variables are always
1340+
uppercase, such like C<$*OUT>, C<$?FILE>.
13341341
1335-
=item1 Methods from the MOP and other internals use "_" to separate multiple words, such like C<add_method>.
1342+
=item1 Methods from the MOP and other internals use "_" to separate multiple
1343+
words, such like C<add_method>.
13361344
13371345
=end pod
13381346

0 commit comments

Comments
 (0)