let AutoDoc set an exit code in the case of failure#280
Open
ThomasBreuer wants to merge 2 commits intogap-packages:masterfrom
Open
let AutoDoc set an exit code in the case of failure#280ThomasBreuer wants to merge 2 commits intogap-packages:masterfrom
AutoDoc set an exit code in the case of failure#280ThomasBreuer wants to merge 2 commits intogap-packages:masterfrom
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #280 +/- ##
==========================================
+ Coverage 79.83% 79.89% +0.06%
==========================================
Files 13 13
Lines 2241 2258 +17
==========================================
+ Hits 1789 1804 +15
- Misses 452 454 +2
|
Author
|
@fingolfin |
AutoDoc return GAPDoc info messagesAutoDoc set an exit code in the case of failure
Just set an exit value in `AutoDoc` in case of failure, do not change the output vaue of `AutoDoc`, undo the proposed changes in `makedoc.g` and in the documentation. (In particular, do not call `QUIT` or `QuitGap` in `makedoc.g`, since this file gets read inside a testfile.)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The idea is the same as in gap-system/gap/pull/5835, but here we deal with package documentation:
When building a manual, collect the info messages printed by
MakeGAPDocDoc, use a heuristic to decide whether the result is acceptable, and letmakedoc.greport failure if not; this can be used in automated tests.For that, the function
AutoDocnow ~~returns a record; up to now, it had no return value.~~sets a nonzero exit code if applicable.This change will automatically become available in all packages that use
makedoc.gcontainingAutoDoccalls. This should not cause problems because the exit code of processingmakedoc.gdid not have a meaning before the change.