Add CI job that checks for consistent @meta blocks in all md pages
#4823
Conversation
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
|
I'd rather wish we could just specify a single |
fingolfin
reviewed
Apr 24, 2025
| meta = """```@meta | ||
| CurrentModule = Oscar | ||
| DocTestSetup = Oscar.doctestsetup() | ||
| ``` |
There was a problem hiding this comment.
Aren't there cases where we need the standard block plus something more? In that case it might be better to only match the first three lines?
Suggested change
| ``` |
fingolfin
reviewed
Apr 24, 2025
| for file in files | ||
| endswith(file, ".md") || continue | ||
| path = joinpath(dir, file) | ||
| if read(`head -n4 $path`, String) != meta |
There was a problem hiding this comment.
Maybe do this
Suggested change
| if read(`head -n4 $path`, String) != meta | |
| if read(`head -n$n $path`, String) != meta |
and then set n to the number of lines in meta?
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.
While looking through the diff of #4758, I noticed that many files have slightly different content in their
@metablocks. This PR adds a simple check that all of them coincide, and if not, prints out a list of files that need adaptation.I deliberately did not attempt to fix these issue yet, as that would produce loads of conflicts with #4758.