[codex] restore decision sufficiency README framing#8
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the Makefile to split the audit checks, ensuring that �sorry� is only checked in Lean source files while allowing it in documentation and scripts. It also updates the README.md with a new badge, a conceptual explanation of decision sufficiency, and clarifications on the build process. A review comment points out a potential issue where the use of ! rg in the Makefile could silently succeed if rg is not installed, and suggests explicitly verifying its availability.
Review Summary by QodoRestore decision sufficiency framing and improve build documentation
WalkthroughsDescription• Restored decision-sufficiency framing paragraph to README • Added "No sorry" CI badge linked to audit workflow • Clarified build instructions for make build and --wfail flag • Separated audit checks to exclude README prose from sorry detection Diagramflowchart LR
A["README.md"] -->|"Add decision sufficiency paragraph"| B["Enhanced documentation"]
A -->|"Add no-sorry badge"| B
C["Makefile"] -->|"Split audit checks"| D["Lean sources only for sorry"]
C -->|"Clarify build instructions"| E["Updated build docs"]
File Changes1. README.md
|
Code Review by Qodo
1. Audit masks rg errors
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 06447f62de
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| audit: | ||
| ! rg -n '\bsorry\b|sorryAx' OrdvecFormalization OrdvecFormalization.lean README.md docs scripts | ||
| ! rg -n '\bsorry\b|sorryAx' OrdvecFormalization OrdvecFormalization.lean | ||
| ! rg -n 'sorryAx' README.md docs scripts |
There was a problem hiding this comment.
Keep plain
sorry audit for docs and scripts
With this narrowed check, plain sorry is no longer audited in docs or scripts; only sorryAx is. In this repo the documentation contains Lean fenced blocks that are not compiled by make check-doc-names beyond extracting theorem names, so a future documented snippet such as by sorry would pass CI while the README now advertises the no-sorry audit. The README badge text needs an exception, but broadening that exception to all docs/scripts weakens the placeholder guard.
Useful? React with 👍 / 👎.
What changed
make buildrunslake build --wfail.make auditso Lean sources are checked for proof placeholders while README prose can contain the no-sorry badge text.Validation
make buildmake check-doc-namesmake audit