KhronosGroup / KhronosGroup/KSCAF_DocGuidelines

Handling of error conditions shall be detailed not generalised (Bug 16059)

Open
#8 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 04:18:08 PDT**

Collectively an SC API shall provide error conditions or status for each individual condition that can occur. An error, state or error message should not cover more than one condition.

**Comment 1 SteveRamm 2016-10-10 07:56:44 PDT**

But is the advice that all non-recoverable error conditions be separately listed?

**Comment 2 Erik Noreke 2016-10-10 07:58:31 PDT**

Accepted as guideline per teleconference 2016-10-10.

Illya to develop language.

**Comment 3 illya@codeplay.com 2016-11-15 03:49:39 PST**

This has been moved to a new issue in Guidelines #16

**Comment 5 illya@codeplay.com 2016-11-28 00:51:32 PST**

Related to Bugzilla 16134

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue says the work was moved to Guidelines #16 and relates to Bugzilla 16134. Start by locating Guidelines #16 and its discussion; the original issue does not identify files or tests, and completion is not defined here beyond developing language for separate error conditions.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.