-
-
Notifications
You must be signed in to change notification settings - Fork 10
docs: Summarize contest_table_provider in dev-notes (#2989) #3088
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughRemoved eleven provider-specific test planning documents and added a single comprehensive TDD guide for implementing and testing ContestTableProvider implementations, consolidating prior plans into one actionable how-to document. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/guides/how-to-add-contest-table-provider.md`:
- Around line 111-115: The doc lists getContestRoundLabel() without parameters
but the example shows getContestRoundLabel(contestId: string); update the guide
to match the real interface: change the requirements bullet to
`getContestRoundLabel(contestId: string)` (or alternatively update the example
to the no-arg form if the interface is actually parameterless) and make the same
change for the other occurrence noted (lines 143-145) so the signature is
consistent across the document; reference getContestRoundLabel to locate and fix
both spots.
- Around line 175-203: The examples in this guide use the instance method
filter(...) but the base API expects setFilterCondition(...); update the example
implementations to call setFilterCondition and pass the predicate used in filter
(e.g., the lambda that extracts round via extractRound and checks 1..41) so
behavior matches the base class contract; also update any other example blocks
that use filter (the later occurrences of the same pattern) to use
setFilterCondition, and keep getMetadata, getDisplayConfig, and
getContestRoundLabel unchanged except for referencing the new filter setup.
KATO-Hiro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
close #2989
See: #2919, #2830, #2836, #2835, #2837, #2838, #2776, #2785, #2797, #2920,
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.