fix: added query key in react firestore example #224
Conversation
|
|
To view this pull requests documentation preview, visit the following URL: docs.page/invertase/tanstack-query-firebase~224 Documentation is deployed and generated using docs.page. |
|
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @marknesh, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a critical oversight in the React Firestore example documentation by adding a necessary parameter to a data fetching hook. This ensures the example is functional and accurately reflects the correct usage, preventing confusion for users trying to implement the documented pattern.
Highlights
- React Firestore Example Correction: The useDocumentQuery hook in the React Firestore example has been updated to include the queryKey parameter, which is essential for the hook to execute queries properly.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly adds the required queryKey to the useDocumentQuery hook in the React Firestore example. This is an important fix, as the hook would not function correctly without it. I have one suggestion to make the example code more robust by dynamically generating the queryKey from the docRef object. This is a good practice to demonstrate in documentation as it avoids hardcoding values and prevents potential bugs if the reference changes.
|
@cabljac Biome does not support formatting in mdx files. Maybe we use prettier to handle formatting of mdx files? |
Updated the React Firestore example to include a
queryKeyinuseDocumentQuerywhich is required inorder for the hook to function properly, without it, no query will be executed.