Skip to content

Commit e8ca633

Browse files
committed
Remove (only) extraneous X<> index markers
Also fix a link to a class. Closes #4496
1 parent c4c4b53 commit e8ca633

File tree

1 file changed

+1
-39
lines changed

1 file changed

+1
-39
lines changed

doc/Language/variables.rakudoc

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,6 @@ hierarchical data structure through C<$=pod>.
480480
Note that all those C<$=someBlockName> support the L<C<Positional>|/type/Positional> and the
481481
L<C<Associative>|/type/Associative> roles.
482482

483-
X<|Syntax,$~>
484483
=head2 The C<~> twigil
485484

486485
The C<~> twigil is for referring to sublanguages (called slangs). The
@@ -1018,8 +1017,6 @@ stay as 84 because the block returns a defined value (C<say> returns
10181017
C<True>). Otherwise the C<die> statement will cause the block to exit
10191018
unsuccessfully, resetting the answer to 42.
10201019

1021-
X<|Syntax,constant (Prefix)>
1022-
X<|Language,constants (syntax)>
10231020
=head2 The C<constant> prefix
10241021

10251022
The C<constant> prefix declares that the value it tags is not going to change
@@ -1358,7 +1355,7 @@ C<META6.json> file:
13581355

13591356
Every resource file is added to an B<installed> Distribution and is
13601357
accessible using a L<C<Hash>|/type/Hash>-like access to C<%?RESOURCES>, returning a
1361-
C<Distribution::Resource> object:
1358+
L<C<Distribution::Resource>|/type/Distribution::Resource> object:
13621359

13631360
=begin code
13641361
my $foo-IO = %?RESOURCES<images/foo.jpg>; # gets an object you can slurp
@@ -1552,15 +1549,13 @@ for examples and more context.
15521549

15531550
C<@*ARGS> is an array of L<C<Str>|/type/Str> containing the arguments from the command line.
15541551

1555-
X<|Variables,&*ARGS-TO-CAPTURE>
15561552
=head4 C<&*ARGS-TO-CAPTURE>
15571553

15581554
A dynamic variable available inside any custom
15591555
L<C<ARGS-TO-CAPTURE>|/language/create-cli#sub_ARGS-TO-CAPTURE> subroutine
15601556
that can be used to perform the default argument parsing. Takes the same
15611557
parameters as are expected of the custom C<ARGS-TO-CAPTURE> subroutine.
15621558

1563-
X<|Variables,&*GENERATE-USAGE>
15641559
=head4 C<&*GENERATE-USAGE>
15651560

15661561
A dynamic variable available inside any custom
@@ -1589,26 +1584,22 @@ Standard error filehandle, AKA I<STDERR>.
15891584
These dynamic variables contain information related to the environment the
15901585
script or program is running in.
15911586

1592-
X<|Variables,%*ENV>
15931587
=head4 C<%*ENV>
15941588

15951589
Operating system environment variables. Numeric values are provided
15961590
as L<allomorphs|/language/glossary#Allomorph>.
15971591

1598-
X<|Variables,$*REPO>
15991592
=head4 C<$*REPO>
16001593

16011594
This variable holds information about modules installed/loaded.
16021595

1603-
X<|Variables,$*INIT-INSTANT>
16041596
=head4 C<$*INIT-INSTANT>
16051597

16061598
C<$*INIT-INSTANT> is an L<C<Instant>|/type/Instant> object representing program
16071599
startup time. In particular, this is when the core code starts up, so the value
16081600
of C<$*INIT-INSTANT> may be a few milliseconds earlier than C<INIT now> or even
16091601
C<BEGIN now> executed in your program.
16101602

1611-
X<|Variables,$*TZ>
16121603
=head4 C<$*TZ>
16131604

16141605
C<$*TZ> is a dynamic variable intended to contain an object with information
@@ -1620,20 +1611,17 @@ further information, set the first time C<$*TZ> is accessed. Any
16201611
daylight saving time changes occurring during the duration of the
16211612
process will B<not> be seen in that case.
16221613

1623-
X<|Variables,$*CWD>
16241614
=head4 C<$*CWD>
16251615

16261616
It contains the C<C>urrent C<W>orking C<D>irectory.
16271617

1628-
X<|Variables,$*KERNEL>
16291618
=head4 C<$*KERNEL>
16301619

16311620
C<$*KERNEL> contains a L<C<Kernel> instance|/type/Kernel>, the C<.gist> of it
16321621
being the current running kernel.
16331622

16341623
say $*KERNEL; # OUTPUT: «linux (4.4.92.31.default)␤»
16351624

1636-
X<|Variables,$*DISTRO>
16371625
=head4 C<$*DISTRO>
16381626

16391627
This object (of type L<C<Distro>|/type/Distro>) contains information about the current operating
@@ -1662,7 +1650,6 @@ useful to create portable programs, such as the path separator:
16621650
# signature => Blob, desc => "2018-12-13T08:50:59.213619+01:00")␤»
16631651

16641652

1665-
X<|Variables,$*VM>
16661653
=head4 C<$*VM>
16671654

16681655
This variable contains the current virtual machine running the code, as well as
@@ -1682,7 +1669,6 @@ configuration values used to create the virtual machine, e.g.
16821669
which are the version of the virtual machine, generally the same one as the one
16831670
used in the interpreter and the overall Raku environment.
16841671

1685-
X<|Variables,$*RAKU>
16861672
=head4 C<$*RAKU>
16871673

16881674
This object of the L<C<Raku>|/type/Raku> class contains information on the
@@ -1703,38 +1689,32 @@ B<Note:> Before Rakudo release 2020.1, this information was only
17031689
available through the C<$*PERL> variable. Since Rakudo release 2020.1,
17041690
it is available through both the C<$*RAKU> and the C<$*PERL> variables.
17051691

1706-
X<|Variables,$*PERL>
17071692
=head4 C<$*PERL>
17081693

17091694
For the foreseeable future, the same as C<$*RAKU>. Will be deprecated at
17101695
some point.
17111696

1712-
X<|Variables,$*PID>
17131697
=head4 C<$*PID>
17141698

17151699
Object containing an integer describing the current Process IDentifier
17161700
(operating system dependent).
17171701

1718-
X<|Variables,$*PROGRAM-NAME>
17191702
=head4 C<$*PROGRAM-NAME>
17201703

17211704
This contains the path to the current executable as it was entered on the
17221705
command line, or C<-e> if raku was invoked with the -e flag.
17231706

1724-
X<|Variables,$*PROGRAM>
17251707
=head4 C<$*PROGRAM>
17261708

17271709
Contains the location (in the form of an L<C<IO::Path>|/type/IO::Path> object) of the Raku
17281710
program being executed.
17291711

1730-
X<|Variables,&*EXIT>
17311712
=head4 C<&*EXIT>
17321713

17331714
This is a L<C<Callable>|/type/Callable> that contains the code that will be
17341715
executed when doing an C<exit()> call. Intended to be used in situations where
17351716
Raku is embedded in another language runtime (such as Inline::Perl6 in Perl).
17361717

1737-
X<|Variables,$*EXIT>
17381718
=head4 C<$*EXIT>
17391719

17401720
Using C<$*EXIT> usually only makes sense in an L<END|/language/phasers#END>
@@ -1744,7 +1724,6 @@ C<exit(N)> was executed.
17441724

17451725
Support for C<$*EXIT> was added in Rakudo compiler release 2023.02.
17461726

1747-
X<|Variables,$*EXCEPTION>
17481727
=head4 C<$*EXCEPTION>
17491728

17501729
Using C<$*EXCEPTION> usually only makes sense in an L<END|/language/phasers#END>
@@ -1754,20 +1733,17 @@ type object otherwise.
17541733

17551734
Support for C<$*EXCEPTION> was added in Rakudo compiler release 2023.02.
17561735

1757-
X<|Variables,$*EXECUTABLE>
17581736
=head4 C<$*EXECUTABLE>
17591737

17601738
Contains an L<C<IO::Path>|/type/IO::Path> absolute path of the raku executable that is currently
17611739
running.
17621740

1763-
X<|Variables,$*EXECUTABLE-NAME>
17641741
=head4 C<$*EXECUTABLE-NAME>
17651742

17661743
Contains the name of the Raku executable that is currently running. (e.g.
17671744
raku-p, raku-m). Favor C<$*EXECUTABLE> over this one, since it's not
17681745
guaranteed that the raku executable is in C<PATH>.
17691746

1770-
X<|Variables,$*USAGE>
17711747
=head4 C<$*USAGE>
17721748

17731749
This is an object of type L<C<Str>|/type/Str> containing the default usage message
@@ -1781,33 +1757,28 @@ sub MAIN($a, :$b, UInt :$ehehe) {
17811757

17821758
It is accessible only inside of MAIN sub.
17831759

1784-
X<|Variables,$*USER>
17851760
=head4 C<$*USER>
17861761

17871762
An L<C<Allomorph>|/type/Allomorph> with information about the user that is running the program. It
17881763
will evaluate to the username if treated as a string and the numeric user id if
17891764
treated as a number.
17901765

1791-
X<|Variables,$*GROUP>
17921766
=head4 C<$*GROUP>
17931767

17941768
An L<C<Allomorph>|/type/Allomorph> with the primary group of the user who is running the program.
17951769
It will evaluate to the groupname only if treated as a string and the numeric
17961770
group id if treated as a number.
17971771

1798-
X<|Variables,$*HOMEDRIVE>
17991772
=head4 C<$*HOMEDRIVE>
18001773

18011774
Contains information about the "home drive" of the user that is running the
18021775
program on Windows. It's not defined in other operating systems.
18031776

1804-
X<|Variables,$*HOMEPATH>
18051777
=head4 C<$*HOMEPATH>
18061778

18071779
Contains information about the path to the user directory that is running the
18081780
program on Windows. It's not defined in other operating systems.
18091781

1810-
X<|Variables,$*HOME>
18111782
=head4 C<$*HOME>
18121783

18131784
Contains an L<C<IO::Path>|/type/IO::Path> object representing the "home directory" of the user
@@ -1816,27 +1787,23 @@ that is running the program. Uses V«%*ENV<HOME>» if set.
18161787
On Windows, uses V«%*ENV<HOMEDRIVE> ~ %*ENV<HOMEPATH>». If the home directory
18171788
cannot be determined, it will be L<C<Any>|/type/Any>.
18181789

1819-
X<|Variables,$*SPEC>
18201790
=head4 C<$*SPEC>
18211791

18221792
Contains the appropriate L<C<IO::Spec>|/type/IO::Spec> sub-class for the platform that the program
18231793
is running on. This is a higher-level class for the operating system; it will
18241794
return C<Unix>, for instance, in the case of Linux (in the form of the
18251795
L<C<IO::Spec>|/type/IO::Spec> class used for the current implementation).
18261796

1827-
X<|Variables,$*TMPDIR>
18281797
=head4 C<$*TMPDIR>
18291798

18301799
This is an L<C<IO::Path>|/type/IO::Path> object representing the "system temporary directory" as
18311800
determined by L«C<.tmpdir IO::Spec::* method>|/routine/tmpdir».
18321801

1833-
X<|Variables,$*THREAD>
18341802
=head4 C<$*THREAD>
18351803

18361804
Contains a L<C<Thread>|/type/Thread> object representing the currently executing
18371805
thread.
18381806

1839-
X<|Variables,$*SCHEDULER>
18401807
=head4 C<$*SCHEDULER>
18411808

18421809
This is a L<C<ThreadPoolScheduler>|/type/ThreadPoolScheduler> object representing
@@ -1853,7 +1820,6 @@ create a scoped copy with the default changed before using them:
18531820

18541821
This behavior is not tested in the spec tests and is subject to change.
18551822

1856-
X<|Variables,$*SAMPLER>
18571823
=head4 C<$*SAMPLER>
18581824

18591825
The current L<C<Telemetry::Sampler>|/type/Telemetry::Sampler> used for making snapshots of system state.
@@ -1864,19 +1830,16 @@ Only available if L<C<Telemetry>|/type/Telemetry> has been loaded.
18641830
These variables affect the behavior of certain functions, and in some cases its
18651831
value can be changed during runtime.
18661832

1867-
X<|Variables,$*DEFAULT-READ-ELEMS>
18681833
=head4 C<$*DEFAULT-READ-ELEMS>
18691834

18701835
Affects the number of bytes read by default by
18711836
L<C<IO::Handle.read>|/type/IO::Handle#method_read>. Its default value is 65536.
18721837

1873-
X<|Variables,$*COLLATION>
18741838
=head4 C<$*COLLATION>
18751839

18761840
This is a L<C<Collation>|/type/Collation> object that can be used to
18771841
configure Unicode collation levels.
18781842

1879-
X<|Variables,$*RAT-OVERFLOW>
18801843
=head4 C<$*RAT-OVERFLOW>
18811844

18821845
Available as of release 2022.02 of the Rakudo compiler.
@@ -1921,7 +1884,6 @@ class ZeroOrInf {
19211884
}
19221885
=end code
19231886

1924-
X<|Variables,$*TOLERANCE>
19251887
=head4 C<$*TOLERANCE>
19261888

19271889
Variable used by the L<C<=~=>|/routine/=~=> operator, and any operations that

0 commit comments

Comments
 (0)