Skip to content

docs: state the real number of shipped schema files - #31

Merged
abrichr merged 1 commit into
mainfrom
docs/readme-schema-file-count
Aug 28, 2026
Merged

docs: state the real number of shipped schema files#31
abrichr merged 1 commit into
mainfrom
docs/readme-schema-file-count

Conversation

@abrichr

@abrichr abrichr commented Aug 28, 2026

Copy link
Copy Markdown
Member

The README rewrite in #30 says nineteen JSON files ship under
openadapt_types/schemas/. Seventeen do. It is a small error, but it is
the kind that no reviewer catches by reading a diff, and it goes stale
again on the next schema anyone adds.

So this corrects the number and puts a test behind it, plus two more in
the same class:

  • the count in the README matches the directory
  • every relative link in the README resolves to a real path
  • every schema filename the README names in backticks is one that ships

The count test fails with README says 'nineteen' JSON files ship under schemas/, but 17 are there. Write 'seventeen'. against the text this PR
replaces, so it catches the exact thing that got through.

docs: on purpose. This is README-only and does not need a version bump.

Note on the red main this came out of

Unrelated to this PR, and already clear. Release and PyPI Publish failed
on main on Aug 26 and Aug 27 with type object 'Actor' has no attribute 'name_email_regex'. GitPython 3.1.60 removed that attribute on Aug 25;
python-semantic-release reads it at cli/config.py:651, and its action is
a Docker action that resolves gitpython~=3.0 fresh on every run. GitPython
3.1.61 put the attribute back this morning. Re-running the same failed run
at the same commit, with no repo change, went green on 3.1.61: run
33113408431.

The README said nineteen JSON files ship under openadapt_types/schemas/.
Seventeen do. Nobody could have caught that by reading the diff, which is
the problem worth fixing rather than the digit.

So the claim now has a test behind it, along with two neighbours in the
same class: every relative link in the README resolves to a real path, and
every schema filename it names in backticks is one the package ships.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@abrichr
abrichr merged commit d06c42d into main Aug 28, 2026
1 check passed
@abrichr
abrichr deleted the docs/readme-schema-file-count branch August 28, 2026 17:08
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