Skip to content

feat: Add module_doc_lint to CI - #1707

Open
jstoobysmith wants to merge 10 commits into
leanprover-community:masterfrom
jstoobysmith:Documentation-linter
Open

jstoobysmith wants to merge 10 commits into
leanprover-community:masterfrom
jstoobysmith:Documentation-linter

Conversation

@jstoobysmith

Copy link
Copy Markdown
Member

Made with the help of Opus 5.5.

Look at the individual commits here rather than the overall files changed, as they tell a better story. The idea here is to:

  1. update the module doc lint so that it runs
  2. add it to our workflows so that it's enforced
  3. update all of the PhyslibAlpha files which fail this
  4. Added the Physlib and QuantumInfo files, which fail this linter, to the exceptions.

@jstoobysmith jstoobysmith changed the title feat: Add module_doc_no_lint to CI feat: Add module_doc_lint to CI Oct 1, 2026
@github-actions github-actions Bot added the large label Oct 1, 2026
@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Thank you for this pull-request (PR). If this is your first PR, welcome to the community!

Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.

  1. Some automated checks will be run on your PR. You can see the results of these checks at the buttom of your PR page. If any of these checks fail, you will need to fix the issues before your PR can be merged. You can learn more about these here, including how to run them locally, which is sometimes quicker than relying on the GitHub Actions. If you have never had a PR merged before, you may have to wait for a reviewer to manually start these checks (this is for security).

  2. A reviewer will look at your PR and may ask you to make changes. This may happen a couple of days after you submit your PR, so you may need to be patient. But it should not be longer than that - if it is please bring it to the attention of the community on the Zulip. The level of review will depend on where your PR is submitted. If it is submitted to ./Physlib or ./QuantumInfo, the review will be more thorough than if it is submitted to ./PhyslibAlpha. You can find out more about what the review process is looking for in our review guidelines. If a reviewer adds an awaiting-author label to your PR, address the review comments, then please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

  3. The reviewer will either approve your PR, or request more changes (in which case we return to step 2). Once your PR is approved, it will be merged by a maintainer, this should happen shortly after approval, though you may get more comments at this stage.

Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages.

If you have any problems or questions, please reach out to the community on the Zulip.

@morrison-daniel morrison-daniel self-assigned this Oct 1, 2026
@morrison-daniel

Copy link
Copy Markdown
Collaborator

Looks good, except I think we should remove the ## 0. One line summary header, I think it is understood that the first line after the heading is a summary so it's extra lines we don't need

@morrison-daniel morrison-daniel added the awaiting-author A reviewer has asked the author a question or requested changes label Oct 1, 2026
@jstoobysmith

Copy link
Copy Markdown
Member Author

@morrison-daniel Implemented this change.

-awaiting-author

@github-actions github-actions Bot removed the awaiting-author A reviewer has asked the author a question or requested changes label Oct 2, 2026

@morrison-daniel morrison-daniel left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It looks like linters fail now since some new files were added, but otherwise looks good. I'll leave my approval and you can merge after fixing the linters.

This branch has not been deployed

No deployments
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