Skip to content

docs: InstallScript is superseded per CHANGELOG but carries no @deprecated marker #175

Description

@s2x

Description

According to CHANGELOG 0.4.7, InstallScript was superseded by the Composer plugin. The class is still present — 192 lines in src/ — with no @deprecated annotation and no comment about its status, and it is not wired into composer.json. A reader cannot tell whether it is live code, a fallback, or dead weight.

It is not purely academic: the bug review found real defects in it (#71, #81), and it is unclear whether they are worth fixing or whether the class should simply go.

Where

  • src/Composer/InstallScript.php
  • CHANGELOG.md — the 0.4.7 entry

Suggested fix

Decide and record the status: mark it @deprecated with the replacement named, or delete it. If it remains as a fallback, document when it runs.

Related: #71, #81

Verification

Found during a full-repo documentation review (2026-08-18); README examples were executed against the current API on PHP 8.5.9. Full finding: review-reports/docs-report.md section L18.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity:lowDrobny problem, higiena kodu

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions