The documentation contains many links to other websites, to other documents and to places within the same document. External websites change, and editorial changes to the documentation can affect link anchors.

This page contains information about link glitches that can be picked up programmatically.

How to help?§

  • Click on the web page where the link is located (a click button is provided).

  • Identify which link is not working by clicking on the link. An erroneous link will take you to a non-existent web page (404 error), or to the top of a file when a place inside the file is expected, or some other error.

  • Click on the edit button at the top of the source webpage, which takes you to the documentation source (a file with the extension .rakudoc). Locate the L<link label|link target> that corresponds to the erroneous link.

  • Work out what the mistake is, eg., a typo, or even the absence of an previously existing site.

  • Change the L<...> code to one that will cure the glitch.

  • Create a PR in the raku/doc repo. Make sure that the name of the PR contains something like cure link glitch. In the comment to the PR include information about how the error occurs and the suggested cure.

Types of error§

The following types of error are common (the examples are illustrations ONLY)

  • external the link is to an external website, eg. L<See this blog| https://someones.xyzzzz.org/wierd_math>

  • local the link is to another page in the Documentation, eg L<... operator | type/operators#... >

  • internal the link is to another place in the same web-page, eg L< see funky stuff | #funky_stuff >

Glitches found§

Remote http/s links with bad host or 404

Remote link test skipped Link-error-test plugin has option no-remote set to True

Links to non-existent interior targets

Document with glitch Displayed text Document containing anchor Attempted anchor name (variants tried)
language/5to6-perlvar
<code>Cool.Str</code> method/type/Cool
method_Str
language/create-cli
multi dispatch/language/glossary
Multi-Dispatch
language/experimental
in the description of <code>unpack</code>/type/Blob
method_unpack
language/glossary
role/language/objects
index-entry-role_declaration
object property/language/objects
index-entry-Property
test suitelanguage/glossary
test_suite
Pull Requestlanguage/glossary
Pull_Request
&quot;stub&quot; operator/language/operators
index-entry-..._operators
type object/language/classtut
index-entry-type_object
language/io-guide
fully reified/language/glossary
index-entry-Reify
<code>will leave</code> trait/language/phasers
index-entry-Phasers__will_trait
language/iterating
sequence operator/language/operators
index-entry-..._operators
language/list
<code>gather</code> statement/language/control
index-entry-lazy_list_gather
<code>enum</code>s/language/typesystem
index-entry-Enumeration-_Enums-_enum
language/math
/language/operators
infix_=~=
language/modules
pragma/language/pragmas
index-entry-lib__pragma
module declaration/language/syntax
index-entry-declarator_unit-declarator_module-declarator_package-Package,_Module,_Class,_Role,_and_Grammar_declaration
language/modules-core
documentation/language/pragmas
index-entry-experimental__pragma
language/numerics
Allomorphs/language/glossary
index-entry-Allomorph
language/operators
empty list/type/List
index-entry-()_empty_list
<code>postcircumfix &lt; &gt;</code>/routine/< >
(Operators)_postcircumfix_<_>
quote-words operator/routine/< >
circumfix_<_>
prefix ...language/operators
prefix_...
language/optut
extended identifier/syntax/identifiers
Extended_identifiers
language/performance
speshed/language/glossary
index-entry-Spesh
#raku channel evalbot/language/glossary
camelia
language/pragmas
<code>try</code> blocks/language/exceptions
index-entry-try_blocks
language/quoting
allomorphs/language/glossary
index-entry-Allomorph
language/rakudoc
indexinglanguage/rakudoc
Indexing_entries
<code>A&lt;&gt; formatting code</code>language/rakudoc
Alias_placements
Aliaseslanguage/rakudoc
Alias_blocks
language/regexes
Unicode propertylanguage/regexes
unicode_properties
<code>\c</code> and <code>\C</code>language/regexes
Regexes,\c
<code>:ignoremark</code>language/regexes
regex_adverb,:ignoremark
language/signatures
multi/language/functions
index-entry-declarator_multi-Multi-dispatch
traits and modifierslanguage/signatures
Parameter_Traits_and_Modifiers
Classes and Objects/language/classtut
Starting_with_class
language/structures
sequence operator/language/operators
index-entry-%E2%80%A6_operators
index-entry-…_operators
language/subscripts
decont/language/glossary
index-entry-decont
<code>postcircumfix { }</code>/routine/{ }
postcircumfix_{_}
<code>postcircumfix [ ]</code>/routine/[ ]
postcircumfix_[_]
reification/language/glossary
index-entry-Reify
language/syntax
interpolation quoting <code>q</code>/language/quoting
Interpolation:_qql
language/traps
<code>LEAVE</code> phaser indicates/language/phasers
index-entry-Phasers__LEAVE-LEAVE
react/language/concurrency
index-entry-react
in a sink context/language/contexts
index-entry-sink_context
allomorph/language/glossary
index-entry-Allomorph
<code>CATCH</code>/language/phasers
index-entry-Phasers__CATCH-CATCH
rand/routine/rand
class_Cool
coerced to <a href="/type/Numeric"><code>Numeric</code></a>/routine/ACCEPTS
(Numeric)_method_ACCEPTS
language/typesystem
captures extra named arguments/type/Method
index-entry-extra_named_arguments
<code>.DEFINITE</code>/language/mop
index-entry-syntax_DEFINITE-DEFINITE
&quot;stub&quot; operator/language/operators
index-entry-..._operators
allomorph/language/glossary
index-entry-Allomorph
language/variables
subscripts/language/subscripts
TOC_Title
the * twigillanguage/variables
The_*_Twigil
semantics of that sigillanguage/variables
Sigil
<code>Match</code>/type/Match
index-entry-$%C2%A2-$%C2%A2
index-entry-$%C2%A2-$%C2%A2
definiteness/language/mop
index-entry-syntax_DEFINITE-DEFINITE
<code>multi</code>/language/functions
index-entry-declarator_multi-Multi-dispatch
allomorphs/language/glossary
index-entry-Allomorph
type/Allomorph
<code>Str.substr</code>/type/Str
method_substr
allomorph/language/glossary
index-entry-Allomorph
type/Any
slice method/type/Seq
method_slice
<code>.map(&amp;block)</code>type/Any
method_map
<code>list.rotor</code>/type/List
method_rotor
type/Baggy
does/routine/does
class_Mu
type/Cancellation
canceltype/Cancellation
cancel
type/Channel
whenever/language/concurrency
index-entry-whenever
type/Cool
Type Graphtype/Cool
typegraphrelations
type/Exception
<code>.DEFINITE</code>/language/mop
index-entry-syntax_DEFINITE-DEFINITE
type/Failure
lvalue/language/glossary
index-entry-lvalue
type/IO/CatHandle
reification/language/glossary
index-entry-Reify
type/IO/Handle
autothread/language/glossary
index-entry-Autothreading
fully reified/language/glossary
index-entry-Reify
type/IO/Path
fully reified/language/glossary
index-entry-Reify
type/Iterable
<code>where</code>/language/signatures
index-entry-Language_where_clause
type/List
<code>Any.list</code>/routine/categorize
(Any)_method_categorize
<code>.flat</code>type/List
method_flat
<code>.map(&amp;block)</code>type/List
method_map
<code>is assoc</code>/language/functions
index-entry-is_assoc_(trait)
binding/language/operators
index-entry-Binding_operator
type/Metamodel/ClassHOW
Higher Order Workings/language/mop
index-entry-syntax_HOW-HOW
type/Metamodel/Mixins
rw/type/Attribute
index-entry-trait_is_rw_(Attribute)-trait_is_rw
type/Mu
react/language/concurrency
index-entry-react
type/Num
=== operator/language/operators
infix_===
type/Pair
ordinary identifiers/syntax/identifiers
Ordinary_identifiers
type/Proc/Async
react/language/concurrency
index-entry-react
type/Signature
<code>where</code> clauses/language/signatures
index-entry-Language_where_clause
type/Str
reified/language/glossary
index-entry-Reify
type/Sub
containers/language/phasers
index-entry-Phasers__will_trait
type/Supply
List.rotor/type/List
method_rotor
type/Test
<code>skip-rest</code>type/Test
skip-rest
<code>bail-out</code>type/Test
bail-out
type/Whatever
an instance/language/classtut
index-entry-.DEFINITE
type/independent-routines
autothread/language/glossary
index-entry-Autothreading
<code>Buf</code>/routine/shift
(Buf)_method_shift

Links to missing files

Document with glitch Displayed text Non-Existent target file
language/compilation
<code>CompUnit::DependencySpecification</code>/type/CompUnit/DependencySpecification
language/contexts
<code>sink</code>Language/sink
language/create-cli
slurpy parameterslanguage/signatures
language/operators
<code>X::Numeric::CannotConvert</code>/type/X/Numeric/CannotConvert
language/typesystem
<code>X::Comp::AdHoc</code>/type/X/Comp/AdHoc
language/variables
<code>Distribution::Resources</code>/type/Distribution/Resources
<code>=~=</code>/routine/=~=
type/Array
is defaultsyntax/is default (Variable)
type/Baggy
<code>X::Immutable</code>/type/X/Immutable
type/Blob
<code>X::Buf::AsStr</code>/type/X/Buf/AsStr
type/Callable
<code>X::Cannot::Capture</code>/type/X/Cannot/Capture
type/Cool
format stringtype/independent-routines
type/Hash
is default/syntax/is default (Attribute)
type/IO/Handle
<code>IO::Store</code>/type/IO::Store<code>IO/Store</code>/type/IO/Store
<code>X::IO::Flush</code>/type/X/IO/Flush
<code>X::IO::Lock</code>/type/X/IO/Lock
type/Rational
<code>X::Numeric::DivideByZero</code>/type/X/Numeric/DivideByZero
type/Str
<code>X::Str::Match::x</code>/type/X/Str/Match/x