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

Convert from tables to sections for builtins. #255

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dj2
Copy link
Contributor

@dj2 dj2 commented Sep 14, 2024

This Cl changes the builtin functions to use titles sections and code
blocks instead of tables. This spaces things out a bit more and fixes
issues where there was wrapping in the function declarations due to the
size of the table columns.

Note, this depends on #254 to have access to the GLSL syntax highlighting.

For an example:

Before

Screenshot 2024-09-13 at 21 57 24

After

Screenshot 2024-09-13 at 21 56 32

@dj2
Copy link
Contributor Author

dj2 commented Sep 14, 2024

This PR is not yet complete, it's an example of what could be done, if the direction seems appropriate I'll update the rest of the builtin function tables to a similar format.

@dj2
Copy link
Contributor Author

dj2 commented Oct 11, 2024

@gnl21 any thoughts on if this is worth persuing? I'm partial to the non-table layout, but that may just be me. I'm happy to update the rest of the current tables to a similar layout, but don't want to sink the effort if it's a dead end in general.

@gnl21
Copy link
Contributor

gnl21 commented Oct 14, 2024

Looking at this, I think making a change like this will probably make these sections nicer. The current tables are a bit of a mess and, though we could fix some of that, some is caused by trying to fit the functions into half the page, which would be solved by doing something like this. The syntax highlighting and having individual numbers/anchors to refer to the individual functions are also benefits and it solves the problem of having to put LaTeX math outside the tables in sections of its own. I think the main downside is making the chapter much longer, so a bit more difficult to scan through.

The numbering of these sections is different in GLSL/ESSL because of ftransform that doesn't exist in ESSL (or core profile, in fact). Maybe it would be preferable to keep any empty sections like that but not that the functions don't exist so that the numbering and any references from things like extension specs is consistent?

This Cl changes the builtin functions to use titles sections and code
blocks instead of tables. This spaces things out a bit more and fixes
issues where there was wrapping in the function declarations due to the
size of the table columns.
@dj2
Copy link
Contributor Author

dj2 commented Oct 27, 2024

I'm still working through all the builtins (there are a lot of them), so this will take a bit of time before everything is changed over. I'm leaving the numbering as is for now, I'd prefer to do that change to have empty sections as a followup given that this is already going to be a large PR.

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