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

Longer term solution for extension name dictionaries #1141

Open
bashbaug opened this issue Apr 3, 2024 · 3 comments
Open

Longer term solution for extension name dictionaries #1141

bashbaug opened this issue Apr 3, 2024 · 3 comments

Comments

@bashbaug
Copy link
Contributor

bashbaug commented Apr 3, 2024

I don't think it would, unfortunately, because AFAICT the extension name without any suffix is defined as an attribute by the build system, in gen/specattribs.adoc, the attribute just doesn't have any value so it doesn't generate any text in the spec. Maybe we could simply update the Makefile to generate attributes with some text instead, say "OOPS!", and that way at least the incorrect attribute usage wouldn't be silent?

Would it be helpful to just define the attribute's value as its name, or an xref to the extension anchor in the appendix? Trivial to do.

Originally posted by @oddhack in #1131 (comment)

@bashbaug
Copy link
Contributor Author

bashbaug commented Apr 3, 2024

Figured it would be easier to track this discussion in an issue vs. a merged PR.

Would it be helpful to just define the attribute's value as its name, or an xref to the extension anchor in the appendix? Trivial to do.

I think this really depends on our goals:

  1. If we want the attribute to generate passable text if it is used un-suffixed then something like this is the right thing to do.
  2. If we want to identify and fix cases when the attribute is used un-suffixed then we want to make it as obviously wrong as we can.

I think either would be preferable over our current "silently generate no text" behavior.

I keep hoping there's a better overall long-term solution, though...

@oddhack
Copy link
Contributor

oddhack commented Apr 3, 2024

IME no matter how much automation is thrown at checking markup - Vulkan and OpenXR have quite a few different scripts looking for different point errors - people can always find new ways to commit markup errors :-(

@oddhack
Copy link
Contributor

oddhack commented Apr 3, 2024

(Related example, you might be surprised how many duplicated connectives like 'and and' / 'the the' are to be found in the spec source).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs WG discussion
Development

No branches or pull requests

2 participants