KhronosGroup / KhronosGroup/KSCAF_DocRequirements
Implementation details: no unnecessary or confusing assumptions allowed
- Dominant language
- CSS
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
API specification should be checked that it does not make unnecessary or confusing assumptions about implementations. For example, the very last sentence of EGL section “Releasing Thread State,” which is section 3.12 in EGL version 1.5 specification, indicates that calling ‘eglGetError’ immediately following a successful call to ‘eglReleaseThread’ “will also result in reallocating per-thread state.” In this case, it is not certain whether verb “will” stands for “should” or whether it indicates an assumption about implementations.
For reference, general issue "Implementation details" is defined as issue no. 32 in the "KSCAF_DocGuidelines" project.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the general “Implementation details” issue referenced as issue 32 in the KSCAF_DocGuidelines project, then review this requirement against the EGL 1.5 “Releasing Thread State” section 3.12 example. Done means the requirement clearly distinguishes normative guidance from assumptions about implementations and addresses the cited wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100