Skip to content

chore: conform to header linter#517

Merged
chenson2018 merged 1 commit intomainfrom
chenson/headers
Apr 24, 2026
Merged

chore: conform to header linter#517
chenson2018 merged 1 commit intomainfrom
chenson/headers

Conversation

@chenson2018
Copy link
Copy Markdown
Collaborator

I recently discovered that while the header linter is included as part of the weekly linting set that CSLib enables, its implementation was such that it only worked in Mathlib. Kim has kindly fixed this in leanprover-community/mathlib4#38396, which should be merged soon.

Unfortunately, when I did the port to the module system, I accidentally placed some of the public section incorrectly above the module docstring, getting no warning from the header linter, and subsequently others followed my lead. Most of the changes here are just this, plus just a few missing module docstrings and typos.

@chenson2018 chenson2018 requested a review from fmontesi as a code owner April 24, 2026 07:30
Copy link
Copy Markdown
Collaborator Author

@chenson2018 chenson2018 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fmontesi @ctchou My comments below are the few places where I left an empty module docstring as a placeholder because I felt you might prefer to write them for files you authored.


public import Cslib.Init

/-! -/
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder.


public import Cslib.Init

/-! -/
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder.


public import Cslib.Logics.LinearLogic.CLL.Basic

/-! -/
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder.


public import Cslib.Computability.Languages.OmegaLanguage

/-! -/
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder.

public import Cslib.Init
public import Mathlib.Computability.Language

/-! -/
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder.

Copy link
Copy Markdown
Collaborator

@fmontesi fmontesi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks!

@chenson2018 chenson2018 added this pull request to the merge queue Apr 24, 2026
Merged via the queue into main with commit 5e8967d Apr 24, 2026
2 checks passed
ctchou added a commit to akhilesh-balaji/cslib that referenced this pull request Apr 25, 2026
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

Successfully merging this pull request may close these issues.

2 participants