Fix hlsl2spv snippet #237
Fix hlsl2spv snippet #237
Conversation
|
@SirLynix is attempting to deploy a commit to the waruqi's projects Team on Vercel. A member of the Team first needs to authorize it. |
✅ Deploy Preview for mellow-creponne-9cce3d ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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 @SirLynix, 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 improves the accuracy of the documentation by fixing a code snippet related to the hlsl2spv rule. The changes involve updating the code block's language identifier to Lua and correcting the dependency requirement to directxshadercompiler, providing a more precise and functional example for users.
Highlights
- Documentation Correction: The
hlsl2spvcode snippet indocs/api/description/builtin-rules.mdhas been updated to reflect correct usage. - Language Specification Update: The code block language for the
hlsl2spvexample was changed fromsh(shell script) tolua, accurately representing the script's language. - Dependency Accuracy: The required dependency for the
hlsl2spvexample was corrected fromglslangtodirectxshadercompiler, ensuring the example uses the appropriate tool for HLSL compilation.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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 fixes the code snippet for the utils.hlsl2spv rule in the documentation. Changing the code block language to lua and updating the dependency to directxshadercompiler are both correct and improve the accuracy of the example.
While reviewing, I noticed a couple of related items that could also be addressed to make the documentation even better:
- In the same code snippet, on line 675, the
add_filescall has a duplicated argument:add_files("src/*.hlsl", "src/*.hlsl"). This seems to be a typo and should probably beadd_files("src/*.hlsl"). - The corresponding documentation in Chinese (
docs/zh/api/description/builtin-rules.md) forutils.hlsl2spvappears to be outdated and contains the same errors that this PR fixes for the English version. It would be great to update it as well.
These are just suggestions for further improvement. The changes in this PR are good and improve the documentation.
No description provided.