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

Style pass #1

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Conversation

tetrapod00
Copy link

Standardized style.
Fix a few factual and copy paste errors.
Fix some formatting.
Consistently use code blocks for literals.
Use sentence case for all parameters.
Avoid math symbols, prefer code-style >=.

Standardized style.
Fix a few factual and copy paste errors.
Fix some formatting.
Consistently use code blocks for literals.
Use sentence case for all parameters.
Avoid math symbols, prefer code-style >=.
| |vec_int_type| **abs**\ (\ |vec_int_type| x)
|vec_type| **abs**\ (\ |vec_type| x)

.. rst-class:: classref-method
Copy link
Owner

Choose a reason for hiding this comment

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

This notation is considerably more verbose than my original using the bars and I can't see any difference in the rendered HTML. Any particular reason why we need to change it?

Copy link
Author

Choose a reason for hiding this comment

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

That's weird! When I built it locally, I noticed two problems with how it rendered the overloaded function entries:

  • The function names did not appear as white, but as gray.
  • The wrapping was incorrect, so the return type of the function appeared at the end of the line.

I didn't get any screenshots, though. I'm going to rebuild and get some screenshots, then post a comment to the original PR so we don't fragment the review.

Copy link
Owner

Choose a reason for hiding this comment

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

Ok, tomorrow I can take some screenshots from my computer too if that would help

Copy link
Author

Choose a reason for hiding this comment

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

Yeah, if both ways render identically for you, this might be something platform dependent. You should test on clamp, textureGrad, or textureProjGrad. For context, for me these look like this with this PR applied, on a 1080 screen, Firefox, Windows 10, 100% zoom in browser:
firefox_Ds37GehAo5
firefox_lcQQPZ0Iu0
firefox_twHKSnvJ6o

@AshbyGeek AshbyGeek merged commit 8972c45 into AshbyGeek:ashbygeek/shader-funcs Oct 24, 2024
1 check 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.

2 participants