Skip to content

Improve how references are used throughout Physlib - #1613

Open
Alex-Zughaid wants to merge 3 commits into
leanprover-community:masterfrom
Alex-Zughaid:references-standardization
Open

Improve how references are used throughout Physlib#1613
Alex-Zughaid wants to merge 3 commits into
leanprover-community:masterfrom
Alex-Zughaid:references-standardization

Conversation

@Alex-Zughaid

Copy link
Copy Markdown
Contributor
  • References section at the top of the file
  • Each reference must appear in the BibTex file
  • The bib ID should appear next to the reference within the Lean files, however we still keep name/author etc. to ensure human readability
  • Added check_references.py which uses regex to check these rules are followed (Similar to lint_bib.sh in mathlib)
  • if you have no references but have a ##References section add * None to make prevent the regex from breaking.

@github-actions

github-actions Bot commented Sep 3, 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.

@github-actions github-actions Bot added the large label Sep 3, 2026
@Alex-Zughaid

Copy link
Copy Markdown
Contributor Author

Very big PR - important files are references.bib and check_references.py

@jstoobysmith

Copy link
Copy Markdown
Member

Could you make a comment on the relevant Zulip channel about this?

@Alex-Zughaid
Alex-Zughaid force-pushed the references-standardization branch from ae204b4 to 7b696c0 Compare September 3, 2026 15:51
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