KhronosGroup / KhronosGroup/OpenCL-Docs
Confusing description of CL_DEVICE_PARTITION_PROPERTIES
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 132
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
The return type of CL_DEVICE_PARTITION_PROPERTIES query is cl_device_partition_property[] (an array), but the description says:
If the device cannot be partitioned (i.e. there is no
partitioning scheme supported by the device that will
return at least two sub-devices), a value of 0 will be
returned.
Should it instead say "an empty array will be returned"? Or does it mean the returned array should contain one element (0)?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation entry for CL_DEVICE_PARTITION_PROPERTIES and review the definition of its cl_device_partition_property[] return value. Confirm the intended no-partitioning result with the surrounding specification text, then clarify the wording so the returned value is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100