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

Update some docs containing OpenGL or GLSL references #6271

Merged
merged 4 commits into from
Sep 15, 2024

Conversation

Nelarius
Copy link
Contributor

@Nelarius Nelarius commented Sep 14, 2024

Connections
#2849

Description
While all examples listed in the issue did have a WGSL example first, and a GLSL example second, there were still a few references to (presumably) old names and OpenGL concepts in the docs.

I think it still makes sense to provide links to the OpenGL wiki in a few places, since the WGSL spec doesn't provide a lot of context. But I've now added explicit links to the OpenGL wiki in places where it was simply stated to read the OpenGL or Vulkan spec.

After this pr, #2849 could potentially be closed.

Testing
Grepped for "Vulkan" and "OpenGL" and it looks like the remaining mentions are relevant.

Checklist

  • Run cargo fmt.
  • Run cargo clippy. If applicable, add:
    • --target wasm32-unknown-unknown
    • --target wasm32-unknown-emscripten
  • Run cargo xtask test to run tests.
  • Add change to CHANGELOG.md. See simple instructions inside file.

@Nelarius Nelarius requested a review from a team as a code owner September 14, 2024 08:08
Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

excellent, thank you so much! Will merge after changelog is fixed

CHANGELOG.md Outdated Show resolved Hide resolved
@cwfitzgerald cwfitzgerald enabled auto-merge (squash) September 15, 2024 06:56
@cwfitzgerald cwfitzgerald merged commit d79ebc4 into gfx-rs:trunk Sep 15, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants