KhronosGroup / KhronosGroup/Vulkan-Docs
Suggestion: Group lists in "Threading Behavior" section by object type
@oddhack is already working on this.
Since Aug 23, 2023.
- Dominant language
- JavaScript
- Stars
- 3.3k
- Forks
- 549
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 2
Description
Right now, the ordering of object types and parameters in this section is more or less random, which makes it hard to get an overview of which object types are involved. I think it would improve readability if these lists were grouped by object type, for example:
- VkBuffer
- The
bufferparameter in vkBindBufferMemory- The
bufferparameter in vkDestroyBuffer- VkImage
- The
imageparameter in vkBindImageMemory- The
imageparameter in vkDestroyImage
These lists are generated by a script, and I don't know how to edit the script to make it output like this.
I also personally think that separating individual parameters from list parameters isn't all that helpful, so I would suggest merging them. But that's separate from this proposal.
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.
Assessment
This issue has not been assessed yet.