Inline examples into the manual (WIP / DO NOT MERGE) #13
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This contains PR #8 and PR #12 and removes the
example
dir, by inlining the examples directly into the manual XML. The examples are then also automatically extracted for use in the test suite.Those tests currently fail due to some diffs which are mostly harmless; i could easily fix them to work in, say, GAP 4.11; the tricky part is to make them work across several GAP versions (see e.g. the differences in output described in issue #5). I could take care of that, but before I invest such effort, I want to check if this is something @jdebeule would be interested in at all.
Thing is, I am still not quite sure if having the example also in
.g
files is explicitly wanted (then this PR here is in the wrong direction), or just for convenience for updating the examples to match the output of the latest versions of GAP & forms - because that can be done differently, as Thomas already described (I could add a scriptupdate_manual_examples.g
to do it automatically, if desired)