KhronosGroup / KhronosGroup/OpenCL-Docs
improve documentation for OpenCL rouge syntax highlighting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 421
- Forks
- 132
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
Copying a discussion from PR https://github.com/KhronosGroup/OpenCL-Docs/pull/691#issuecomment-966739193:
Why is there both opencl.rb and opencl_c.rb?
At least it should be explained in the comments what they are really doing.
Reply:
The "opencl" source type is for OpenCL API syntax highlighting, so it primarily includes the OpenCL API types for things like cl_platform_id, cl_context, cl_command_queue, etc.
The "opencl_c" source type is for the OpenCL C programming language, so it includes things like the __kernel and __global keywords, types like char2 and image2d_t, and built-in functions like get_global_id.
I'm totally open to clarifying this further. Where would you like to see more comments?
Reply:
The difference make sense.
But reading the .rb should make it clear:class OpenCL < Cpp title "OpenCL" desc "The OpenCL standard for heterogeneous computing from the Khronos Group"perhaps with OpenCL host API instead of just OpenCL?
Also clarify the tags?
The comments are always useful at the top of the .rb to explain what is happening in the file but probably that if the title, desc and tag are clearer one can understand.
In the host API, it is probably the C or the C++ host API, then it would be nice to have also the API calls highlighted?
We could also look into auto-generating some or most of these files from the XML file, at least for the OpenCL API.
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
Compare opencl.rb and opencl_c.rb first, using the discussion to understand the distinction between the OpenCL host API and OpenCL C highlighting. Clarify the comments, titles, descriptions, and tags so their purposes are apparent, and determine whether API calls are in scope; the issue also mentions possible XML-based generation, but does not define that work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100