@@ -25,22 +25,22 @@ the signature does not automatically cause the test to fail: some differences in
25
25
signature (such as different names for positional parameters) represent
26
26
different implementation choices rather than an error in the docs.
27
27
28
- NOTE: when you specify a rakudo source directory using the RAKUDO_SRC environment
28
+ I < NOTE > : when you specify a rakudo source directory using the RAKUDO_SRC
29
+ environment
29
30
variable, this script will attempt to test a specific version by using git checkout
30
31
to switch that checkout to a specific version during the test, and run
31
32
"git checkout -" at the end to reset the state.
32
33
33
- NOTE: This test uses introspection from the running copy of rakudo to find
34
+ I < NOTE > : This test uses introspection from the running copy of Rakudo to find
34
35
information in the source code. If you are running a different version of raku
35
36
then the RAKUDO_SRC directory, it may be unable to find certain method definitions.
36
37
37
38
To ensure that implementation details don't cause failing tests, we check only
38
39
for certain discrepancies that are guaranteed to indicate a
39
40
substantive/non-implementation detail mismatch between Rakudo and the docs.
40
41
41
- Currently, we only test for one category of discrepancies:
42
-
43
- = item Methods that are defined with a specific invocant in Rakudo but not in the
42
+ Currently, we only test for one category of discrepancies: Methods that are
43
+ defined with a specific invocant in Rakudo but not in the
44
44
docs (this helpfully also catches the situation where a documentation signature
45
45
was I < intended > to have an invocant, but where someone forgot to end the
46
46
invocant with a C < : > )
0 commit comments