Skip to content

docs: name the subject in two README sentences - #92

Merged
kmadan merged 1 commit into
mainfrom
docs/register-tighten-two-lines
Aug 30, 2026
Merged

docs: name the subject in two README sentences#92
kmadan merged 1 commit into
mainfrom
docs/register-tighten-two-lines

Conversation

@kmadan

@kmadan kmadan commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

What this changes

Two sentences in README.md, both introduced in 86a986e (#91). Documentation
only; no .rego file is touched.

Type

  • New policy (specify framework path)
  • New framework directory
  • Policy update (semver MINOR — backward compatible)
  • Policy update (semver MAJOR — breaking; new v2/ directory)
  • Bug fix
  • Tooling / CI / docs

Detail

README.md L66. "The distinction matters:" names nothing, and the sentence
it introduces already states the condition. The lead-in is removed so the
sentence begins with the mechanism.

README.md L227. #91 replaced a quantified claim with an unquantified one.
"Other EU AI Act policies also depend on declared facts" is weaker than the
figure the file already reports under "The problem", and it drops the proportion
a reader needs in order to judge how much of the Act is automatable at all. It
now reads: 170 of the 185 input-field reads across the 29 policies are
declarations. The hedge "natural starting points" becomes "the starting points".

Checklist

  • Every new .rego has a sibling *_test.rego — n/a, no .rego changed
  • Metadata block present on every new policy — n/a, no new policy
  • Framework-level README.md lists the new policy — n/a, no new policy
  • opa check --ignore custom/ . passes locally
  • regal lint --ignore-files custom/ . passes locally
  • Not breaking; no v2/ directory required

Also run locally, all passing: check-anchors.sh, check-version-refs.sh,
model-card-coverage.sh --check.

Source(s)

No regulation is encoded or reinterpreted by this PR.

Notes for reviewers

The restored figure is consistent with the "The problem" section rather than a
new claim, and find international/eu_ai_act -name '*.rego' ! -name '*_test.rego'
still returns 29. Both sentences are prose only; no figure, link or heading
target changes.

Two sentences introduced in 86a986e depart from the register the rest of the
file follows.

"The distinction matters:" names nothing. The sentence it introduces already
states the condition, so the lead-in is removed and the sentence begins with
the mechanism.

The second sentence replaced a quantified claim with an unquantified one.
"Other EU AI Act policies also depend on declared facts" is weaker than the
figure the file already reports two hundred lines earlier, and drops the
proportion a reader needs in order to judge how much of the Act is automatable.
It now states that 170 of the 185 input-field reads across the 29 policies are
declarations, consistent with the split given under "The problem". The hedge
"natural starting points" becomes "the starting points".

No figure, link or heading target changes. opa check, regal lint,
check-anchors.sh, check-version-refs.sh and model-card-coverage.sh --check all
pass.
@kmadan
kmadan merged commit d281368 into main Aug 30, 2026
3 checks passed
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.

1 participant