KhronosGroup / KhronosGroup/KSCAF_DocGuidelines

SC API guideline to reduce options to a minimum (Bug 16056)

Open
#7 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

**illya@codeplay.com 2016-10-10 01:17:52 PDT**

An API specification can list many modes of operation, types of things, many enumerations, acceptable formats etc. Recommend the SC specification state only one mandatory item to to remain operation to reduce implementation complexity and testing. For example OpenCL specifiaction stipulates many image formats. The SC version only mandates one (or none?), the others are optional.

**Comment 1 Erik Noreke 2016-10-10 07:37:54 PDT**

Accepted per teleconference 2016-10-10.

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Read the existing SC specification guidelines and the accepted teleconference decision first, then determine where the rule belongs and whether each option category requires one mandatory item or permits none; done means the guideline clearly limits mandatory choices while leaving others optional.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.