KhronosGroup / KhronosGroup/Vulkan-Docs
Bugs with proposed fixes for the core+KHR specification version 1.2.141
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
Suggested fixes as comments placed throughout PDF build of KHR extended version 141 of the specification.
Comment primitives used and their intended meaning:
- red strike-trough: designates parts of the text that should be removed (may include single character sequences, punctuation marks as well as white spaces);
- green underline: designates parts of the text that should be replaced (see comment attached to each item for details)
- orange highlight: designates misc. editorial suggestions (see comment attached to each item for details)
- sticky note: designates parts of the text that might be missing (see comment attached to each item for details)
There are numerous VUs missing pNext description. I had being marking them, up to a point I came to a conclusion that it surely must be by design.
Most of the text in drawing-command-related VUs is duplicated across multiple variants of basic drawing/dispatching commands. Personally I found repeatedly reading same content over and over again distracting and tedious. Not to mention that it surely must be hard to maintain.
Consider using "comments view/list" or some sort of "go to next/previous comment" functionality of your PDF-viewer to not get overwhelmed or miss anything.
Verified to view correctly in Adobe Acrobat Reader and built-in Firefox PDF-viewer.
Hope you will find it useful.
Contributor guide
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
Review the attached vkspec.pdf using a PDF viewer's comments list, starting with the marked specification passages and the notes on missing pNext descriptions and duplicated drawing-command VUs. Done means each proposed correction has been assessed and the accepted specification text is updated consistently.
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