Skip to content

docs: fix documentation drift and document the unreleased 6.5 - #374

Merged
guillaume-sainthillier merged 1 commit into
6.xfrom
docs/audit-fixes
Oct 13, 2026
Merged

guillaume-sainthillier merged 1 commit into
6.xfrom
docs/audit-fixes

Conversation

@guillaume-sainthillier

Copy link
Copy Markdown
Member

Fixes the mismatches found in a documentation audit. No code change apart from @internal tags.

Unreleased 6.5

The docs site is published on every push to 6.x, so it already described behaviour that isn't tagged yet (\r line endings, out-of-order records and zero-filled dates throwing).

  • CHANGELOG: the section is now # 6.5 (unreleased), with an upgrade note: files that parsed in 6.4 can now throw.
  • Docs: :::note[Since 6.5] asides on the affected statements, a :::caution[Upgrading to 6.5] block on the troubleshooting page, and "since 6.5" mentions in the README features and home page.

Missing CHANGELOG entries

6.1 to 6.4 rebuilt from the tags and GitHub releases, including Operation::getBankOperationReference() (6.1) and every class becoming final (6.3).

Inaccuracies

  • "Strict by default" implied non-strict mode skips the record-order checks; they throw in both modes. Reworded as in the CFONB 120 guide.
  • "Blank lines are ignored": only empty lines are; whitespace-only lines throw. Fixed in the four places.
  • CFONB 240 dates are typed DateTimeInterface, not DateTimeImmutable (README, home page, CFONB 240 guide).
  • Troubleshooting shows the real "Unable to find a parser" message, with its line break.
  • CONTRIBUTING describes the jobs CI really runs (Rector isn't one of them), and the "All at once" command now includes Rector, composer validate/normalize and the docs examples check.
  • composer.json: description mentions CFONB 120 and 240; swift keyword dropped (the library doesn't parse SWIFT formats).
  • Banking\Element, Banking\Noop and Contracts\ParserInterface marked @internal: only used by the internal parsers.

phpunit (120 tests), phpstan, psalm, php-cs-fixer, rector, render-examples.php --check and composer validate/normalize pass.

…ributing guide

- mark 6.5 as unreleased in the changelog, add an upgrade note on the files it now rejects, and the missing 6.1 to 6.4 entries
- flag the 6.5 behaviour (\r line endings, record order and date checks) as such in the README and the docs site
- strict mode only relaxes blank CFONB 120 operation references; only empty lines are skipped, not whitespace-only ones
- CFONB 240 date getters are typed DateTimeInterface
- describe the real CI jobs and complete the all-in-one quality command
- show the newline of the "Unable to find a parser" message
- composer.json: describe CFONB 120/240, drop the unrelated swift keyword
- mark Element, Noop and ParserInterface @internal
@guillaume-sainthillier
guillaume-sainthillier merged commit 9ea43e1 into 6.x Oct 13, 2026
18 checks passed
@guillaume-sainthillier
guillaume-sainthillier deleted the docs/audit-fixes branch October 13, 2026 13:33
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