-
Notifications
You must be signed in to change notification settings - Fork 129
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
CI: check for jldoctest end markers and unknown admonitions #4325
Conversation
16cf89e
to
529f535
Compare
529f535
to
6f8619e
Compare
1c676b8
to
0e83418
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4325 +/- ##
==========================================
+ Coverage 84.49% 84.52% +0.02%
==========================================
Files 645 646 +1
Lines 85589 85631 +42
==========================================
+ Hits 72321 72382 +61
+ Misses 13268 13249 -19
|
This job needs about 1 minute (+ building Oscar and deps). I think this is acceptable for the kind of tests it performs. And I would hope that the building time goes down once this is merged and makes use of the actions cache. Once this is merged, I think it should be marked as a "required" job. |
* CI: check for jldoctest end markers and unknown admonitions * docs: fix two admonitions * add explanation * use !== nothing (cherry picked from commit e8f8ecc)
x-ref: #4321
cc: @fingolfin @lgoettgens
Edit: errors look like here: https://github.com/oscar-system/Oscar.jl/actions/runs/11879378622
The error should link to the corresponding docstring. Unfortunately I could not figure out how to find the exact line inside the docstring for the jldoctest / admonition.
If the errors are triggered from new changes these should show up as annotations in the
Files changed
tab as well.