This is an automated email from the ASF dual-hosted git repository.
paulk-asert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
The following commit(s) were added to refs/heads/master by this push:
new 0b0f8480db fix doc processing warnings
0b0f8480db is described below
commit 0b0f8480dbcc4902113f4820c5c61c09ef691a35
Author: Paul King <[email protected]>
AuthorDate: Sun May 31 09:10:06 2026 +1000
fix doc processing warnings
---
.../java/org/codehaus/groovy/ast/tools/GeneralUtils.java | 8 ++++----
src/spec/doc/_type-checking-extensions.adoc | 4 ++--
src/spec/doc/core-domain-specific-languages.adoc | 2 +-
.../groovy-contracts/src/spec/doc/contracts-userguide.adoc | 6 +++---
.../src/spec/doc/_monadic-comprehensions.adoc | 12 ++++++------
.../groovy-typecheckers/src/spec/doc/typecheckers.adoc | 4 ++--
6 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/codehaus/groovy/ast/tools/GeneralUtils.java
b/src/main/java/org/codehaus/groovy/ast/tools/GeneralUtils.java
index 1815fe3a92..057c244440 100644
--- a/src/main/java/org/codehaus/groovy/ast/tools/GeneralUtils.java
+++ b/src/main/java/org/codehaus/groovy/ast/tools/GeneralUtils.java
@@ -131,7 +131,7 @@ public class GeneralUtils {
*/
public static final Token ASSIGN = Token.newSymbol(Types.ASSIGN
, -1, -1);
/**
- * AST compare-to operator token ("<=>").
+ * AST compare-to operator token ("<=>").
*/
public static final Token CMP =
Token.newSymbol(Types.COMPARE_TO , -1, -1);
/**
@@ -155,15 +155,15 @@ public class GeneralUtils {
*/
public static final Token GT =
Token.newSymbol(Types.COMPARE_GREATER_THAN , -1, -1);
/**
- * AST less-than-or-equal operator token ("<=").
+ * AST less-than-or-equal operator token ("<=").
*/
public static final Token LE =
Token.newSymbol(Types.COMPARE_LESS_THAN_EQUAL , -1, -1);
/**
- * AST less-than operator token ("<").
+ * AST less-than operator token ("<").
*/
public static final Token LT =
Token.newSymbol(Types.COMPARE_LESS_THAN , -1, -1);
/**
- * AST logical AND operator token ("&&").
+ * AST logical AND operator token ("&&").
*/
public static final Token AND =
Token.newSymbol(Types.LOGICAL_AND , -1, -1);
/**
diff --git a/src/spec/doc/_type-checking-extensions.adoc
b/src/spec/doc/_type-checking-extensions.adoc
index d74374476b..f8b3448015 100644
--- a/src/spec/doc/_type-checking-extensions.adoc
+++ b/src/spec/doc/_type-checking-extensions.adoc
@@ -28,7 +28,7 @@ This chapter is the SDK reference for *writing* a type
checking extension.
For the extensions Groovy already ships with (regex checking, format-string
checking, null safety, frame conditions, purity, parallel-reduction
associativity, and monadic comprehensions), see the
-<<built-in-auxiliary-type-checkers,Built-in auxiliary type checkers>> chapter.
+link:typecheckers.html#built-in-auxiliary-type-checkers[Built-in auxiliary
type checkers] chapter.
====
== Writing a type checking extension
@@ -126,7 +126,7 @@ use those type checking extension scripts.
Extensions can accept named parameters using Groovy's named-argument style
within the extension string.
The example below uses `NullChecker`, one of the
-<<built-in-auxiliary-type-checkers,bundled checkers>>; the same syntax applies
+link:typecheckers.html#built-in-auxiliary-type-checkers[bundled checkers]; the
same syntax applies
to any extension that reads the `options` map.
[source,groovy]
diff --git a/src/spec/doc/core-domain-specific-languages.adoc
b/src/spec/doc/core-domain-specific-languages.adoc
index 0f926013e7..7d0737da98 100644
--- a/src/spec/doc/core-domain-specific-languages.adoc
+++ b/src/spec/doc/core-domain-specific-languages.adoc
@@ -1057,7 +1057,7 @@ metaprogramming] section of this manual.
It may be interesting, in some circumstances, to provide feedback about wrong
code to the user as soon as possible,
that is to say when the DSL script is compiled, rather than having to wait for
the execution of the script. However,
this is not often possible with dynamic code. Groovy actually provides a
practical answer to this known as
-link:type-checking-extensions.html[type checking extensions].
+link:core-semantics.html#type-checking-extensions[type checking extensions].
== Builders
diff --git a/subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc
b/subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc
index 1aa1100641..b206c6bf03 100644
--- a/subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc
+++ b/subprojects/groovy-contracts/src/spec/doc/contracts-userguide.adoc
@@ -181,7 +181,7 @@ _loop variant_, also known as a termination measure. The
closure must yield a va
whose successive iteration values form a strictly decreasing, well-founded
sequence.
Two value shapes are supported:
-* A single `Comparable` value — usually numeric — that strictly
decreases
+* A single `Comparable` value — usually numeric — that strictly
decreases
on every iteration. If the value is also a `Number`, it must additionally
remain
non-negative.
* A `List` of `Comparable` elements, compared lexicographically: the first
position
@@ -195,8 +195,8 @@ a `LoopVariantViolation` (a subclass of `AssertionError`)
is thrown.
This is inspired by similar constructs in design-by-contract languages such as
Dafny and Eiffel.
-NOTE: `@Decreases` is incubating in Groovy 6.0.0. The contract — in
particular
-the scalar non-negativity rule and the lexicographic shape for `List`
variants —
+NOTE: `@Decreases` is incubating in Groovy 6.0.0. The contract — in
particular
+the scalar non-negativity rule and the lexicographic shape for `List`
variants —
may be relaxed or extended in a future release based on usage feedback.
=== While loop
diff --git
a/subprojects/groovy-macro-library/src/spec/doc/_monadic-comprehensions.adoc
b/subprojects/groovy-macro-library/src/spec/doc/_monadic-comprehensions.adoc
index b7b7169128..d02e0e63c2 100644
--- a/subprojects/groovy-macro-library/src/spec/doc/_monadic-comprehensions.adoc
+++ b/subprojects/groovy-macro-library/src/spec/doc/_monadic-comprehensions.adoc
@@ -66,7 +66,7 @@ IMPORTANT: For all but the most trivial uses, `DO` under
`@CompileStatic` or
runtime dispatcher signature `Comprehensions.bind(Object, Closure):Object`
erases the carrier's element type and the comprehension's result type, so
without the extension each generator's bound name and the whole `DO`
-expression both fall through to `Object` — which the static type
+expression both fall through to `Object` — which the static type
checker will reject as soon as the body or downstream code does anything
type-specific with either. See <<monadic-static>>.
@@ -99,9 +99,9 @@ A type participates as a carrier when, in order, the first
match winning:
. it is annotated `@groovy.transform.Monadic`, optionally declaring
non-conventional method names.
-The allow-list also recognises common Functional Java carriers by name —
+The allow-list also recognises common Functional Java carriers by name —
`fj.data.Option`, `fj.data.List`, `fj.data.Stream`, `fj.data.Validation` and
-`fj.P1` — using that library's `bind`/`map` convention. Groovy takes no
+`fj.P1` — using that library's `bind`/`map` convention. Groovy takes no
dependency on Functional Java; the names are matched reflectively, and the
generator closure is coerced to `fj.F` automatically. `fj.data.Either` is not
directly monadic in Functional Java (bind lives on its `.right()`/`.left()`
@@ -151,7 +151,7 @@
include::../test/MonadicComprehensionsSpecTest.groovy[tags=do_static,indent=0]
TIP: The typical symptom of forgetting the extension is a static type
checking error reporting that some operation cannot be found on `Object`
-— either inside the body (a generator's bound name has erased to
+— either inside the body (a generator's bound name has erased to
`Object`) or on the `DO` expression itself (the result has erased to
`Object`). Adding `extensions = 'groovy.typecheckers.MonadicChecker'` to
the `@CompileStatic`/`@TypeChecked` annotation resolves it.
@@ -167,12 +167,12 @@ a compile-time lint:
@TypeChecked(extensions = 'groovy.typecheckers.MonadicShapeChecker')
----
-It catches the two classic shape mistakes — a `bind`
(i.e. `flatMap`)
+It catches the two classic shape mistakes — a `bind`
(i.e. `flatMap`)
closure that returns a non-carrier value, and a `map` closure that returns
the same carrier where `flatMap` was meant. A `strict` option tightens
what is flagged; the default lenient mode reports only high-confidence
violations. Both checkers are documented from the type-checker side in the
-<<built-in-auxiliary-type-checkers,Built-in auxiliary type checkers>> chapter.
+link:typecheckers.html#built-in-auxiliary-type-checkers[Built-in auxiliary
type checkers] chapter.
[[monadic-when]]
== When to use `DO`
diff --git a/subprojects/groovy-typecheckers/src/spec/doc/typecheckers.adoc
b/subprojects/groovy-typecheckers/src/spec/doc/typecheckers.adoc
index a625747562..cf0b881fb1 100644
--- a/subprojects/groovy-typecheckers/src/spec/doc/typecheckers.adoc
+++ b/subprojects/groovy-typecheckers/src/spec/doc/typecheckers.adoc
@@ -34,7 +34,7 @@ as needed to cater for scenarios where the standard type
checking isn't sufficie
This chapter catalogues the type-checking extensions that ship with Groovy.
For the API used to write your own, see the
-<<type-checking-extensions,Type checking extensions>> chapter.
+link:core-semantics.html#type-checking-extensions[Type checking extensions]
chapter.
Groovy offers a suite of built-in type checkers that provide additional
compile-time verification for specific concerns:
@@ -1448,7 +1448,7 @@ expose structural `flatMap` / `map`, or be annotated with
`@Monadic`).
The macro itself, its desugaring strategy, the participating-carrier rules,
and the `@Monadic` annotation are documented in the
-<<monadic-comprehensions,Monadic Comprehensions>> chapter. This section
+link:core-async-await.html#monadic-comprehensions[Monadic Comprehensions]
chapter. This section
covers only the type-checking surface.
== Checking Hand-written Monadic Chains (Incubating)
