Repository navigation
docs: author the last context stubs (deprecations, decisions, api-standard) - #608
Merged
irfan-dahir merged 1 commit intoOct 11, 2026
Merged
Conversation
…andard Doc debt goes 4-of-7 -> 7-of-7: every mapped role now has an authored document (resolve exits 0; explicitly declined roles are the only non-written ones). - DEPRECATIONS.md: real ledger, rows measured from @deprecated tags in src/Model. Nine currently-deprecated accessors (Anime::getTitle*, Manga::getTitle*, Producer::getName) each map to the getTitles() replacement; the v4->v5 diff removed nothing, so the Removed table is empty with the retention rule stated; section 5 is a running grep reconciliation, logged as a future toolchain-gate candidate. - DECISIONS.md: finished (stub marker removed). The template's open DECIDEs are answered (organisation=topical, corrections=inline paragraph, split at 25 entries/section, significance = 'would a reader assume a mistake?'), with the two existing entries retained and the decision-format references kept. - API-STANDARD.md: authored from MEASURED conventions of the ^5 codebase (naming tables, the Request/Parser/Model/client contract, the exception envelope, Results/Pagination shape, Constants::DISPLAY_* rule), so review rejects code drifting from reality rather than toward aspiration. Section 7 names the two genuinely-open items for maintainer sign-off instead of guessing. Committed through the merged pre-commit hook (suite gates + grumphp).
CrafterSama
pushed a commit
to CrafterSama/jikan
that referenced
this pull request
Oct 27, 2026
6-PR review fixes: docs.manifest.json._readme still described api-standard, changelog, contributing, decisions and deprecations as unwritten stubs (resolve exit 5); they have all been authored (jikan-me#607/jikan-me#608). Now states all seven mapped roles are authored and five are declined. survey.json (derived) re-run so its source stamp and census reflect the current tree. Whole-stack review status at HEAD: repo-health 8 clean / 0 findings / 11 honest refusals; quality-debt all-A; composer test 394/394.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #607. Completes the context layer: doc debt goes 4-of-7 → 7-of-7 — every mapped role now has an authored document.
DEPRECATIONS.md — authored (stub removed)
Real ledger, rows measured from the
@deprecatedtags insrc/Model:Anime::getTitle*(4) andManga::getTitle*(4) →getTitles(): array;Producer::getName()→getTitles(): array.Removedis empty with the retention rule stated.grep -rn "@deprecated" src/Modelreconciliation, logged as a futuretoolchainGatescandidate.DECISIONS.md — finished (stub marker removed)
The template's open DECIDE questions answered in-document: organisation (topical, Date carries chronology), corrections (inline
**Correction (date):**paragraph is the standard), split trigger (25 entries per section), and significance threshold ("would a reader in a year assume this was a mistake?"). The two existing entries (constants, exemptions) retained verbatim.API-STANDARD.md — authored (stub removed)
Everything measured from the
^5codebase, so review rejects drift from reality, not toward aspiration:ParserException/BadResponseExceptionenvelope, typed nullability,Constants::DISPLAY_*rule);Results/Paginationshape;httpClientWrapper, rawCrawlerleakage, live-network tests);Result
Committed through the merged pre-commit hook (suite gates + grumphp, clean).