KhronosGroup / KhronosGroup/KSCAF_DocRequirements
Implementation details: undefined aspects shall be minimized
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 4
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
At present, many aspects of the existing APIs which are specified as undefined can actually be defined in a simple way. An illustration could be that, by specification, issuing OpenGL commands when a context is not current to a thread results in undefined behavior. All undefined aspects should be listed, reviewed and defined, and if the definition is not possible, then reasons should be listed. By listing the reasons, it may be possible to further analyze the issue and possibly create alternative data structures and functions, which would not have undefined aspects.
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
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
No files or tests are named. Start by reviewing the related “Implementation details” issue 32 and inventory the existing APIs whose behavior is specified as undefined, using the OpenGL context example as a reference. Document a definition for each aspect where possible, or record why it cannot be defined.
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
- 20/100