Remove @hidden from GraphqlServerOptions and FirebaseContext #1812
Conversation
These interfaces should be visible in the documentation. Removed the @hidden JSDoc tag from GraphqlServerOptions and FirebaseContext in src/v2/providers/dataconnect/graphql.ts. Co-authored-by: egilmorez <5544707+egilmorez@users.noreply.github.com>
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Summary of ChangesHello @egilmorez, 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 focuses on enhancing the discoverability of key interfaces within the GraphQL server configuration. By removing specific documentation tags, two important interfaces are now exposed in the generated documentation, making it easier for developers to understand and interact with these components. The change improves the overall clarity and usability of the codebase's public API. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes the @hidden tag from GraphqlServerOptions and FirebaseContext to expose them in the documentation. The changes are correct for this purpose. I've left a comment suggesting to also expose the related GraphqlResolvers interface, which is part of the public API of GraphqlServerOptions but is still marked as hidden. This will ensure the documentation is complete for developers.
| } | ||
|
|
||
| /** | ||
| * @hidden |
There was a problem hiding this comment.
Removing @hidden here exposes GraphqlServerOptions, but its resolvers property is of type GraphqlResolvers, which is still marked as @hidden (line 152). For complete documentation, consider making GraphqlResolvers public as well.
1 participant
Removed @hidden tags from GraphqlServerOptions and FirebaseContext in src/v2/providers/dataconnect/graphql.ts to expose them in the documentation. Verified that the code builds and passes linting.
PR created automatically by Jules for task 11427497224066701372 started by @egilmorez