Skip to content

Fix (or replace) doc/ref/testconsistency.g #6274

@ThomasBreuer

Description

@ThomasBreuer

When doc/ref/testconsistency.g is read by GAP, a lot of output appears that claims to exhibit errors in the GAPDoc syntax of the GAP manual.
Some of these claims are wrong, for example "Transitivity uses Oper instead of Attr" -- Transitivity is both an attribute and a non-unary operation, and one wants to be able to refer to the non-unary situation.
Luckily, most of the output is irrelevant for the status value that is used in a CI test.

It would be already an improvement if the wrong output lines would be omitted.

A better solution would be if the idea of "more strict checks" would become part of GAPDoc.
The decision about "officially" correct GAPDoc syntax should be left to GAPDoc, perhaps via an optional argument that causes a more strict check of references etc.
Such an official "strict mode" could be used also by package manuals based on GAPDoc, if one really wants this.
Perhaps @frankluebeck has an opinion about this.

Metadata

Metadata

Labels

kind: discussiondiscussions, questions, requests for comments, and so on

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions