Skip to content

✨ Quality: documentation and testing - Improve hook JSDoc and useList coverage - #96

Merged
galiprandi merged 1 commit into
mainfrom
quality-docs-and-list-coverage-12220292469051835812
Jun 21, 2026
Merged

✨ Quality: documentation and testing - Improve hook JSDoc and useList coverage#96
galiprandi merged 1 commit into
mainfrom
quality-docs-and-list-coverage-12220292469051835812

Conversation

@galiprandi

Copy link
Copy Markdown
Owner

💡 What: This improvement enhances the documentation for several core hooks (useDebounce, useThrottle, useList, useAI) and increases the branch coverage for the useList hook.

🎯 Why:

  • useDebounce and useThrottle lacked descriptions for their generic type parameters.
  • useList lacked a usage example in its JSDoc.
  • The useAI example was missing one of the destructured functions in its second example.
  • useList had uncovered branches related to restricted key handling in toggle and upsert methods.

📊 Impact: Improves developer experience through better documentation and ensures the useList hook is robust against prototype pollution attempts in all its matching-based methods.

✅ Verification:

  • Ran pnpm test to verify 100% branch coverage for useList.tsx.
  • Ran pnpm lint and pnpm build to ensure code quality and build integrity.

PR created automatically by Jules for task 12220292469051835812 started by @galiprandi

… coverage

- Added descriptive @template tags to useDebounce and useThrottle.
- Added comprehensive @example usage to useList hook.
- Fixed useAI @example to include getApiProgress in destructuring.
- Added security test cases for toggle and upsert in useList, achieving 100% branch coverage.
@google-labs-jules

Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@galiprandi
galiprandi merged commit 999b83c into main Jun 21, 2026
4 checks passed
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