Skip to content

State the declaring contract for all methods#128

Merged
zanbaldwin merged 1 commit into
6.xfrom
z/api-contracts
Jul 3, 2026
Merged

State the declaring contract for all methods#128
zanbaldwin merged 1 commit into
6.xfrom
z/api-contracts

Conversation

@zanbaldwin

Copy link
Copy Markdown
Member

No description provided.

@zanbaldwin zanbaldwin self-assigned this Jul 3, 2026
@greptile-apps

greptile-apps Bot commented Jul 3, 2026

Copy link
Copy Markdown

Greptile Summary

This PR updates the API reference to group methods by their declaring contracts. The main changes are:

  • Adds a Contract column to the method table.
  • Documents newer factory and output methods alongside existing API methods.
  • Marks deprecated methods directly in the table.

Confidence Score: 4/5

Documentation-only change with low runtime risk.

Remaining findings are non-blocking documentation completeness gaps in the API table.

docs/10-api.md should include all still-declared methods before merge.

T-Rex T-Rex Logs

What T-Rex did

  • I reviewed the before artifact to verify the API docs base state, noting the base commit fce31ad and that the table header did not include a Contract column.
  • I reviewed the after artifact to verify the API docs after the change, noting the head commit 05cbb95 with a Contract column, 61 parsed rows, and zero rows missing or misaligned with a declaring contract.
  • I concluded the change improves the user-visible API reference by replacing the flat availability table with a contract-aware mapping.

View all artifacts

T-Rex Ran code and verified through T-Rex

Important Files Changed

Filename Overview
docs/10-api.md Reworks the API reference into a contract-oriented table, but omits some still-declared factory and deprecated accessor methods.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
participant Reader
participant APIReference as docs/10-api.md
participant Contracts as PHP interfaces
Reader->>APIReference: Look up method availability
APIReference->>Contracts: Groups methods by declaring contract
Contracts-->>APIReference: Interface-declared methods and version support
APIReference-->>Reader: Contract, signature, return type, IPv4/IPv6/Multi support
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
participant Reader
participant APIReference as docs/10-api.md
participant Contracts as PHP interfaces
Reader->>APIReference: Look up method availability
APIReference->>Contracts: Groups methods by declaring contract
Contracts-->>APIReference: Interface-declared methods and version support
APIReference-->>Reader: Contract, signature, return type, IPv4/IPv6/Multi support
Loading

Reviews (2): Last reviewed commit: "docs(api): 📚 state the declaring contra..." | Re-trigger Greptile

Comment thread docs/10-api.md
Comment thread docs/10-api.md Outdated
@greptile-apps

greptile-apps Bot commented Jul 3, 2026

Copy link
Copy Markdown

Want your agent to iterate on Greptile's feedback? Try greploops.

@zanbaldwin zanbaldwin merged commit 24894cc into 6.x Jul 3, 2026
25 checks passed
@zanbaldwin zanbaldwin deleted the z/api-contracts branch July 3, 2026 14:15
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