OpenCL-Docs icon indicating copy to clipboard operation
OpenCL-Docs copied to clipboard

improve error code consistency, part one

Open bashbaug opened this issue 6 months ago • 2 comments

This is a PR to partially address the way we document error conditions, see #1320 and in particular https://github.com/KhronosGroup/OpenCL-Docs/issues/1320#issuecomment-2745919727.

This doesn't modify the entire spec, but:

  • It's already a very large PR.
  • I think it's a nice improvement over what we have currently.

We should decide whether we merge these changes in their partial state or whether we wait to review and merge the changes for the entire spec in the same PR.

Regardless, it would be beneficial to decide what to do with this PR sooner rather than later, because any changes to error conditions will likely result in merge conflicts that will need to be resolved.

bashbaug avatar Jun 24 '25 00:06 bashbaug

Now that v3.0.19 is published I'd like to start getting these changes over the finish line. Would it be helpful to break this PR into smaller pieces? If so, what is the right size?

One PR per API is probably a bit too fine-grained since there are over 100 APIs. Maybe one PR per "chapter"? Or, is this PR tractable as-is, and folks just need a bit more time for review?

bashbaug avatar Jul 14 '25 17:07 bashbaug

I'll break this PR into smaller pieces for easier review. Moving to "draft" so it doesn't get accidentally merged.

bashbaug avatar Aug 13 '25 00:08 bashbaug