Skip to content

docs[cli]: state what mock match details actually cover - #202

Open
dajiaohuang wants to merge 1 commit into
0xjuanma:mainfrom
dajiaohuang:docs/mock-match-details-coverage
Open

dajiaohuang wants to merge 1 commit into
0xjuanma:mainfrom
dajiaohuang:docs/mock-match-details-coverage

Conversation

@dajiaohuang

Copy link
Copy Markdown

Fixes #201.

docs/CLI.md told agents that --mock exposes the full MatchDetails shape "(events, lineups, stats, formations)" and recommended mock IDs for validating a lineup jq pipeline. The bundled mocks do not carry those fields:

$ golazo match 2001 --mock | jq '.data[0] | {home_starting, home_lineup, home_formation}'
{
  "home_starting": null,
  "home_lineup": null,
  "home_formation": null
}

internal/data/mock_details.go adds only Events, Statistics, Venue, Referee and Attendance to the embedded Match; the same holds for the away side and for every bundled ID (2002-2005, 1001-1012). display_minute is also only populated on some bundled events (2004/2005) while the documented event schema lists it unconditionally.

The change is limited to docs/CLI.md:

  • the quick-start sentence no longer offers mock lineups;
  • the Known-limitations bullet now says exactly which fields mock details cover, which ones they omit, and that lineup/formation validation must happen against real matches in the TUI.

Verified by re-reading both edited paragraphs and checking the claims against the built binary (golazo match <id> --mock for 2001-2005 and 1001-1012). No code or schema changes.

docs/CLI.md told agents that --mock exposes the full MatchDetails shape
(events, lineups, stats, formations) and recommended it for validating
lineup pipelines. The bundled mocks in internal/data/mock_details.go only
add events, statistics, venue, referee and attendance to the embedded
Match, so home_lineup/home_starting/home_formation and their away
counterparts are absent, and display_minute is populated on only some
bundled events.

Describe the actual mock coverage, and point lineup/formation validation
at real matches in the TUI.

Fixes 0xjuanma#201
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.

[Docs]: mock match details have no lineups/formations despite CLI.md's testing guidance

1 participant