docs: categorical metadata distribution and filtering feature spec - #1738
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
✅ Fast Track: all required checks passed — auto-approved.
Reflects |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7a34385ef5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,215 @@ | |||
| # Feature: Categorical Metadata Distribution and Filter | |||
|
|
|||
| **Status:** Implemented; QA ready | |||
There was a problem hiding this comment.
Align the status with the unchecked acceptance criteria
With the spec marked Implemented; QA ready, leaving every acceptance criterion unchecked makes the document read as if none of the shipped behavior has been verified, which is confusing for QA and future readers. Either mark the implemented criteria as complete or change the status to reflect that validation is still pending.
AGENTS.md reference: AGENTS.md:L39-L41
Useful? React with 👍 / 👎.
| - Concrete values are ordered by the endpoint (frequency with deterministic ties). **Missing** and | ||
| non-zero **Other** are appended as semantic buckets. |
There was a problem hiding this comment.
Keep semantic bucket ordering in sync with the UI
Because this spec is marked implemented, saying Missing and Other are appended is inaccurate for the current panel: categorical buckets are passed through selectVisibleCounts, which sorts all buckets by count/name and only uses pinned to keep Missing/Other included in top-N, so a high-count Missing or Other bucket can render above concrete values. Update the spec or the rendering so the documented ordering matches the product.
Useful? React with 👍 / 👎.
| - `useCategoricalMetadataDistribution.ts` parallels the numeric hook, calls | ||
| `POST /metadata/value-counts`, forwards the reactive `ImageFilter`, maps semantic buckets without | ||
| label-based identity, and keeps prior data during refetch. |
There was a problem hiding this comment.
Use the collection-scoped value-counts endpoint
The implemented route is collection-scoped (/collections/{collection_id}/metadata/value-counts), and the generated client requires that collection_id path parameter. Documenting the hook as calling POST /metadata/value-counts points implementers at a non-existent endpoint, so the contract should include the full collection-scoped path.
Useful? React with 👍 / 👎.
7a34385 to
c2eea76
Compare
20d7d76 to
58efaf1
Compare
Fast Track checks no longer pass; dismissing the bot approval.
Summary
Stacked on p12. Docs-only PR.
Adds
docs/features/lig-9585-categorical-metadata-distribution-filter.md— the full feature spec for the categorical distribution panel (LIG-9585). Covers:__missing__,__other__, literal collisions)Test plan
Part of LIG-9585.