Skip to content
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

fix: shaderlab doc #2307

Merged
merged 1 commit into from
Aug 5, 2024
Merged

fix: shaderlab doc #2307

merged 1 commit into from
Aug 5, 2024

Conversation

MrKou47
Copy link
Member

@MrKou47 MrKou47 commented Aug 5, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the shader documentation to simplify the declaration of BlendState within a Pass, enhancing clarity and usability.
    • Changes reflected in both English and Chinese documentation to ensure consistency for all users.

Copy link

coderabbitai bot commented Aug 5, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes simplify the syntax for declaring BlendState within shader Pass structures by removing the explicit variable naming. This streamlining enhances the clarity of shader documentation while maintaining functionality, allowing developers to focus more on implementation rather than syntax.

Changes

Files Change Summary
docs/en/graphics/shader/shaderLab/syntax/pass.mdx, docs/zh/graphics/shader/shaderLab/syntax/pass.mdx The BlendState declaration has been simplified from BlendState blendState { to BlendState {, allowing for a more direct usage of blend properties without a specific variable name.

Poem

In shader lands where colors blend,
A streamlined syntax is our new friend.
No longer must we name each state,
Just BlendState {, isn't that great?
With clarity shining, our shaders will gleam,
Hopping along in a coder's dream! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@MrKou47 MrKou47 merged commit 352e435 into main Aug 5, 2024
6 of 7 checks passed
@GuoLei1990 GuoLei1990 added the documentation Improvements or additions to documentation label Aug 7, 2024
@GuoLei1990 GuoLei1990 deleted the doc/fix-shaderlab branch August 7, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants