-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add some utility functions for docs #5
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
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.
Summary of Changes
Hello @QuadnucYard, 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 introduces several new utility functions aimed at enhancing the usability and flexibility of document manipulation within the library. The changes provide more ergonomic ways to inspect document states, prepare documents for advanced operations, and construct documents from common data structures like arrays.
Highlights
- New
Docutility: I've added anis_nilmethod to theDoctype, which provides a convenient way to check if a document is theNilvariant. This can simplify conditional logic when working with documents. - New
DocBuilderutility: I've introduced aninto_refmethod forDocBuilder. This function allows converting aDocBuilderinto a newDocBuilderthat holds an internal reference to the original document, which can be useful for preparing documents for cloning or other operations requiring a reference. - Array
Prettyimplementation: I've implemented thePrettytrait for fixed-size arrays ([T; N]). This enables arrays ofPretty-implementing types to be directly converted into aDocBuilderby concatenating their elements, simplifying the creation of documents from array data.
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 is currently in preview and 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 to provide feedback.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces utility functions for document handling, including checking for nil documents and creating references. The changes are well-implemented, with suggestions provided for efficiency and test coverage.
Added
Doc::is_nilDocBuilder::into_refto make inner ref, which can help prepare for cloning.[T; N]::pretty, making it easier to concat.