Skip to content
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

Merged
merged 4 commits into from
Nov 18, 2024

Conversation

benlorenz
Copy link
Member

@benlorenz benlorenz commented Nov 17, 2024

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.

Copy link

codecov bot commented Nov 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.52%. Comparing base (fb767f2) to head (9e0f07b).
Report is 5 commits behind head on master.

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     
Files with missing lines Coverage Δ
...imental/BasisLieHighestWeight/src/UserFunctions.jl 92.42% <ø> (ø)

... and 8 files with indirect coverage changes

@benlorenz benlorenz marked this pull request as ready for review November 17, 2024 15:57
etc/check_docstrings.jl Outdated Show resolved Hide resolved
@lgoettgens
Copy link
Member

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.

@benlorenz benlorenz merged commit e8f8ecc into master Nov 18, 2024
31 checks passed
@benlorenz benlorenz deleted the bl/checkdocstrings branch November 18, 2024 10:44
benlorenz added a commit that referenced this pull request Nov 18, 2024
* CI: check for jldoctest end markers and unknown admonitions

* docs: fix two admonitions

* add explanation

* use !== nothing

(cherry picked from commit e8f8ecc)
@benlorenz benlorenz mentioned this pull request Nov 18, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants