KhronosGroup / KhronosGroup/OpenCL-Docs
weird anchors for CL_MEM_OBJECT_IMAGE1D, etc.
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
Editorial:
The current anchors for CL_MEM_OBJECT_IMAGE1D and similar image types are a little weird, linking to "Table 23. Required host_ptr buffer sizes for images". I think it would make more sense to link to one of the following locations, instead:
* The descriptions in the "image_type" field in the [image descriptor](https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#image-descriptor) structure.
* The descriptions for the [CL_MEM_TYPE](https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#CL_MEM_TYPE) query from clGetMemObjectInfo.
Contributor guide
Research direction
Locate the source entries that generate the CL_MEM_OBJECT_IMAGE1D and related anchors, then compare them with the image descriptor image_type descriptions and the CL_MEM_TYPE clGetMemObjectInfo query descriptions linked in the issue. Update the anchors to the selected location and verify that the generated OpenCL API documentation links to the intended descriptions.
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
- 45/100