KhronosGroup / KhronosGroup/OpenCL-Docs

Start a simple style guide

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

Description

The specifications could benefit from listing some simple style rules such as

```quote
* Use "work-group", not "workgroup" or "work group".
* Use dictionary entries for API entry point, i.e. `{clEntryName}`, not `clEntryName`.
```

The Vulkan specification has an extensive style guide [1], which is a great thing to aspire too, but to start I just mean a `styleguide.txt` that lists simple rules and guidelines. Focusing on things that sometimes end up being inconsistent.

[1] https://www.khronos.org/registry/vulkan/specs/1.2/styleguide.html

Contributor guide

Open the contributing guide

Research direction

Review the specification sources and the Vulkan style guide linked in the issue before creating the proposed styleguide.txt. Collect recurring inconsistencies such as terminology and API-entry-point formatting, then document a focused initial set of rules; done means the file exists and its guidance is clear and consistent.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.