Skip to content

Commit 32cc153

Browse files
authored
Fix missing index entries (#4567)
Zero-width index directives don't seem to work if they appear after a heading, so fix all occurrences by moving them before the heading. The broken index directives also had the side-effect of causing blank headings in some situations, e.g. - https://docs.raku.org/language/variables#Sigils - https://docs.raku.org/language/operators#infix_%2E%2E%2E Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
1 parent f157d1b commit 32cc153

9 files changed

+23
-24
lines changed

doc/Language/modules-core.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ note that the implementation is not part of the Raku specification and thus
99
might be subject to change without prior notice. The following is a list of
1010
them, along with links to their source code.
1111

12-
=head2 C<CompUnit::*> modules and roles
1312
X<|Modules,CompUnit (Rakudo classes)>
13+
=head2 C<CompUnit::*> modules and roles
1414

1515
These modules are mostly used by distribution build tools, and are not intended
1616
to be used (at least until version 6.c) by the final user.

doc/Language/operators.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3155,9 +3155,9 @@ lists are replaced by the value from applying the operator to the list:
31553155
1..3 X~ <a b c> X~ 9
31563156
# produces (1a9 1b9 1c9 2a9 2b9 2c9 3a9 3b9 3c9)
31573157

3158-
=head2 infix C«...»
31593158
X<|Infix operators,...>X<|Infix operators,...^>X<|Infix operators,^...>X<|Infix operators,^...^>
31603159
X<|Infix operators,…>X<|Infix operators,…^>X<|Infix operators,^…>X<|Infix operators,^…^>
3160+
=head2 infix C«...»
31613161

31623162
multi infix:<...>(**@) is assoc<list>
31633163
multi infix:<...^>(**@) is assoc<list>

doc/Language/quoting.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,8 @@ say "alive"; # this line is dead code
315315
CONTROL { .die };
316316
=end code
317317

318-
=head2 Word quoting: qw
319318
X<|Syntax,qw word quote>
319+
=head2 Word quoting: qw
320320

321321
=for code :allow<B L>
322322
qw|! @ # $ % ^ & * \| < > | eqv '! @ # $ % ^ & * | < >'.words.list;

doc/Language/syntax.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ if True {say "Hello"}
5959

6060
though you can't leave out any more whitespace in this last example.
6161

62-
=head2 X<Unspace|Syntax,\>
6362
X<|Syntax,Unspace>
63+
=head2 X<Unspace|Syntax,\>
6464

6565
In places where the compiler would not allow a space you can use
6666
any amount of whitespace, as long as it is quoted with a backslash.

doc/Language/typesystem.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,8 @@ you must use private attribute notation instead.
260260
# OUTPUT: «C.new(attr => 42)␤
261261
# C.new(attr => "answer")␤»
262262

263-
=head4 Fallback method
264263
X<|Language,FALLBACK (method)>
264+
=head4 Fallback method
265265

266266
A method with the special name C<FALLBACK> will be called when other means to
267267
resolve the name produce no result. The first argument holds the name and all

doc/Language/unicode_entry.rakudoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ available as actual characters on a keyboard.
1414
General information about entering unicode under various operating systems
1515
and environments can be found on the Wikipedia L<unicode input page|https://en.wikipedia.org/wiki/Unicode_input>.
1616

17-
=head1 XCompose (Linux)
1817
X<|Reference,XCompose>
18+
=head1 XCompose (Linux)
1919

2020
Xorg includes digraph support using a
2121
L<I<Compose key>|https://en.wikipedia.org/wiki/Compose_key#GNU.2FLinux> .
@@ -52,8 +52,8 @@ If you use KDE you can put this file in C<~/.config/plasma-workspace/env/compose
5252
and that should work. Other desktop environments will be different. Look up
5353
how to set environment variables in yours or use the system-wide option above.
5454

55-
=head2 ibus
5655
X<|Reference,ibus>
56+
=head2 ibus
5757

5858
If you have problems entering high codepoint symbols such as B<🐧> using the
5959
C<xim> input module, you can instead use ibus. You will have to install the ibus
@@ -66,8 +66,8 @@ ibus-daemon --xim --verbose --daemonize --replace
6666
Setting C<--xim> should also allow programs not using ibus to still use the xim
6767
input method and be backward compatible.
6868

69-
=head1 XKB (Linux)
7069
X<|Reference,Xkb>
70+
=head1 XKB (Linux)
7171

7272
The X Window System receives keyboard events using the XKB extension, which makes it possible to read the output of various kinds of keyboards, provided that there's a configuration file available.
7373

@@ -350,8 +350,8 @@ and login back again.
350350
Note that since Ubuntu Gnome uses one C<Super> key for its own purposes, one might want to substitute one or
351351
both the Super_* keys with, for example, Meta_R.
352352

353-
=head1 WinCompose (Windows)
354353
X<|Reference,WinCompose>
354+
=head1 WinCompose (Windows)
355355

356356
L<WinCompose|https://github.com/samhocevar/wincompose> adds
357357
L<compose key|https://en.wikipedia.org/wiki/Compose_key> functionality to Windows.
@@ -433,8 +433,8 @@ L<digraphs|https://github.com/gfldex/digraphs> if you prefer a Raku friendly
433433
digraph table over L<RFC 1345|https://tools.ietf.org/html/rfc1345> or change it
434434
to your needs.
435435

436-
=head2 Vim
437436
X<|Reference,Vim>
437+
=head2 Vim
438438

439439
In L<Vim|https://www.vim.org/>, unicode characters are entered (in
440440
insert-mode) by pressing first C<Ctrl-V> (also denoted C<^V>), then C<u> and
@@ -466,8 +466,8 @@ configured to optionally replace ASCII based ops with their Unicode based
466466
equivalents. This will convert the ASCII based ops on the fly while typing
467467
them.
468468

469-
=head2 Emacs
470469
X<|Reference,Emacs>
470+
=head2 Emacs
471471

472472
In L<Emacs|https://www.gnu.org/software/emacs/>, unicode characters are
473473
entered by first entering the chord C<C-x 8 RET> at which point the

doc/Language/variables.rakudoc

+10-11
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ followed optionally by a second special character named I<twigil> and then an
1111
L<identifier|/language/syntax#Identifiers>.
1212

1313

14-
=head1 Sigils
1514
X<|Syntax,$>X<|Syntax,@>X<|Syntax,% (sigil)>X<|Syntax,&>
15+
=head1 Sigils
1616

1717
There are four sigils. The scalar-sigil C<$>, the positional-sigil C<@>, the
1818
associative-sigil C<%> and the callable-sigil C<&>.
@@ -184,8 +184,8 @@ C<@array>, such that it becomes an Array with a single element, namely a List.
184184
See L<operators|/language/operators> for more details on precedence and
185185
associativity.
186186

187-
=head2 Sigilless variables
188187
X<|Syntax,\ (sigilless variables)>
188+
=head2 Sigilless variables
189189

190190
Using the C<\> prefix, it's possible to create variables that do not
191191
have a sigil:
@@ -240,10 +240,9 @@ variable, that is, where that variable is defined and can be changed.
240240

241241
=end table
242242

243-
X<|Syntax,$*>
244243
X<|Language,Dynamically scoped variables>
245-
=head2 The C<*> twigil
246244
X<|Syntax,*>X<|Syntax,$*>X<|Syntax,@*>X<|Syntax,%*>X<|Syntax,&*>
245+
=head2 The C<*> twigil
247246

248247
This twigil is used for dynamic variables which are looked up through the
249248
caller's, not through the outer, scope. Look at the example below.N<The example
@@ -306,8 +305,8 @@ scope when declared with C<our>. Dynamic resolution and resolution through
306305
symbol tables introduced with C<our> are two orthogonal issues.
307306

308307

309-
=head2 The C<?> twigil
310308
X<|Syntax,$?>X<|Syntax,?>X<|Syntax,$?>X<|Syntax,@?>X<|Syntax,%?>X<|Syntax,&?>
309+
=head2 The C<?> twigil
311310

312311
Compile-time variables may be addressed via the C<?> twigil. They are known
313312
to the compiler and may not be modified after being compiled in. A popular
@@ -320,8 +319,8 @@ example for this is:
320319
For a list of these special variables, see
321320
L<compile-time variables|/language/variables#Compile-time_variables>.
322321

323-
=head2 The C<!> twigil
324322
X<|Syntax,!>X<|Syntax,$!>X<|Syntax,@!>X<|Syntax,%!>X<|Syntax,&!>
323+
=head2 The C<!> twigil
325324

326325
L<Attributes|/language/objects#Attributes> are variables that exist per instance
327326
of a class. They may be directly accessed from within the class via C<!>:
@@ -343,8 +342,8 @@ you though. For more details on objects, classes and their attributes see
343342
L<object orientation|/language/objects>.
344343

345344

346-
=head2 The C<.> twigil
347345
X<|Syntax,.>X<|Syntax,$.>X<|Syntax,@.>X<|Syntax,%.>X<|Syntax,&.>
346+
=head2 The C<.> twigil
348347

349348
The C<.> twigil isn't really for variables at all. In fact, something along
350349
the lines of
@@ -376,8 +375,8 @@ is also possible:
376375
For more details on objects, classes and their attributes and methods see
377376
L<object orientation|/language/objects>.
378377

379-
=head2 The C<^> twigil
380378
X<|Syntax,^>X<|Syntax,$^>X<|Syntax,@^>X<|Syntax,%^>X<|Syntax,&^>
379+
=head2 The C<^> twigil
381380

382381
The C<^> twigil declares a formal positional parameter to blocks or subroutines;
383382
that is, variables of the form C<$^variable> are a type of placeholder variable.
@@ -417,8 +416,8 @@ in the L<Sigils table|#Sigils>. Thus C<@^array>, C<%^hash>, and C<&^fun> are all
417416
valid placeholder variables.
418417

419418

420-
=head2 The C<:> twigil
421419
X<|Syntax,:>X<|Syntax,$:>X<|Syntax,@:>X<|Syntax,%:>X<|Syntax,&:>
420+
=head2 The C<:> twigil
422421

423422
The C<:> twigil declares a formal named parameter to a block or subroutine.
424423
Variables declared using this form are a type of placeholder variable too.
@@ -460,8 +459,8 @@ the L<semantics of that sigil|#Sigils>). Thus C<@:array>, C<%:hash>, and
460459
C<&:fun> are all valid, and each creates a formal named parameter with the
461460
specified sigil.
462461

463-
=head2 The C<=> twigil
464462
X<|Syntax,=>X<|Syntax,$=>X<|Syntax,@=>X<|Syntax,%=>X<|Syntax,&=>
463+
=head2 The C<=> twigil
465464

466465
The C<=> twigil is used to access Pod variables. Every Pod block in the
467466
current file can be accessed via a Pod object, such as C<$=data>,
@@ -481,8 +480,8 @@ hierarchical data structure through C<$=pod>.
481480
Note that all those C<$=someBlockName> support the L<C<Positional>|/type/Positional> and the
482481
L<C<Associative>|/type/Associative> roles.
483482

484-
=head2 The C<~> twigil
485483
X<|Syntax,$~>
484+
=head2 The C<~> twigil
486485

487486
The C<~> twigil is for referring to sublanguages (called slangs). The
488487
following are useful:

doc/Type/IO/Handle.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -881,8 +881,8 @@ with 'test'.IO {
881881

882882
Returns C<True> if the handle is open, C<False> otherwise.
883883

884-
=head2 method t
885884
X<|Reference,tty>
885+
=head2 method t
886886

887887
method t(IO::Handle:D: --> Bool:D)
888888

doc/Type/Sub.rakudoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ L<code, precedence and associativity|/language/functions#Defining_operators>.
5050
The syntax used in their definition is an example of
5151
L<extended identifiers|/language/syntax#Extended_identifiers>.
5252

53-
=head1 Traits
5453
X<|Syntax,trait_mod (declarator)>
54+
=head1 Traits
5555

5656
A C<Trait> is a sub that is applied at compile time to various objects like
5757
classes, routines or L<containers|/language/phasers#index-entry-will_trait>. It

0 commit comments

Comments
 (0)