Skip to content

Commit

Permalink
Minor doc changes Raku#3871
Browse files Browse the repository at this point in the history
  • Loading branch information
JJ committed Apr 17, 2022
1 parent 52615ee commit 30206e4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions xt/check-signatures.t
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,22 @@ the signature does not automatically cause the test to fail: some differences in
signature (such as different names for positional parameters) represent
different implementation choices rather than an error in the docs.
NOTE: when you specify a rakudo source directory using the RAKUDO_SRC environment
I<NOTE>: when you specify a rakudo source directory using the RAKUDO_SRC
environment
variable, this script will attempt to test a specific version by using git checkout
to switch that checkout to a specific version during the test, and run
"git checkout -" at the end to reset the state.
NOTE: This test uses introspection from the running copy of rakudo to find
I<NOTE>: This test uses introspection from the running copy of Rakudo to find
information in the source code. If you are running a different version of raku
then the RAKUDO_SRC directory, it may be unable to find certain method definitions.
To ensure that implementation details don't cause failing tests, we check only
for certain discrepancies that are guaranteed to indicate a
substantive/non-implementation detail mismatch between Rakudo and the docs.
Currently, we only test for one category of discrepancies:
=item Methods that are defined with a specific invocant in Rakudo but not in the
Currently, we only test for one category of discrepancies: Methods that are
defined with a specific invocant in Rakudo but not in the
docs (this helpfully also catches the situation where a documentation signature
was I<intended> to have an invocant, but where someone forgot to end the
invocant with a C<:>)
Expand Down

0 comments on commit 30206e4

Please sign in to comment.