-
Notifications
You must be signed in to change notification settings - Fork 161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added consistency check for the reference manual #538
Added consistency check for the reference manual #538
Conversation
Seems useful. Perhaps also add a |
Interesting check. I would say that Some of the examples shown above seem to come from Maybe one could get rid of
and as a byproduct the documentation becomes correct? |
I've allowed
|
In addition to
|
fcf942c
to
7a5efac
Compare
I've pushed the next version which also looks for However, there are five genuine errors - see the log below. For example, when the
|
7a5efac
to
c6a15af
Compare
This test checks that ManSections are of the right type.
If the 2nd optional argument is true, warnings will be displayed in case of a type mismatch.
testcoverage.g filename is misleading since that script looked for ManSections having no examples, and had nothing in common with code coverage. Now testconsistency.g should perform all kinds of manual health checks. At the moment, it checks types in ManSections and Ref elements and find ManSections without examples.
f77791a
to
962255e
Compare
This now should be ready for merge. I've added
|
This commit fixes some of the inconsistency in the manual pointed out in Issue gap-system#538.
This commit fixes some of the inconsistency in the manual pointed out in Issue gap-system#538.
This commit fixes some of the inconsistency in the manual pointed out in Issue gap-system#538.
This commit fixes some of the inconsistency in the manual pointed out in Issue gap-system#538.
Added consistency check for the reference manual (WIP)
Just to note: I've now checked stable-4.8 branch. Initially we had 363 errors, and now after all cleanups the following remains:
|
This test checks that ManSections are of the right type. Run it in
doc/ref
directory withand it will return the output of the form