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

Properly silence the docPrime linter in downstream projects #20560

Open
adomani opened this issue Jan 7, 2025 · 0 comments
Open

Properly silence the docPrime linter in downstream projects #20560

adomani opened this issue Jan 7, 2025 · 0 comments

Comments

@adomani
Copy link
Collaborator

adomani commented Jan 7, 2025

The docPrime linter uses the file scripts/nolints_prime_decls.txt to keep track of which primed declarations already existed when the linter was created and should not be flagged by the linter.

This works well for mathlib, but downstream projects get flooded by warnings when they build mathlib from scratch, instead of downloading the cache via lake exe cache get.

The reason is that the linter looks for the file in scripts/nolints_prime_decls.txt, does not find it in the downstream project and therefore complains about all primed declarations. Once the cache has been saved with the linter warnings, lake then replays it every time.

For this reason, the docPrime linter is now disabled in mathlib.

See these previous Zulip discussions:

#20559 is the PR where the linter was disabled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant