KhronosGroup / KhronosGroup/OpenCL-Docs

Improve clUpdateMutableCommandsKHR error wording

Open
#1,209 0 comments 0 reactions 0 assignees View on GitHub
cl_khr_command_buffer
Dominant language
Python
Stars
420
Forks
131
Avg merge
5d 13h
Merged PRs (30d)
11

Description

As [raised in a PR review](https://github.com/KhronosGroup/OpenCL-Docs/pull/1045#discussion_r1672096624) the error wording around `clUpdateMutableCommandsKHR()` could be improved.

There are many errors that can be returned here based on errors returned by core OpenCL entry-points, as well as invalid usage of the entry-point itself. This makes the current language quite dense, we should improve the readability.

One idea is to categories errors in the description of commands such that we could refer to the categories later on.

Contributor guide

Open the contributing guide

Research direction

Start with the clUpdateMutableCommandsKHR() description and the linked PR review discussion. Identify the error categories needed to make the current dense wording readable, then revise the description so those categories can be referred to consistently; done means the full set of core-entry-point and invalid-usage errors is clearer.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.