KhronosGroup / KhronosGroup/Vulkan-Docs

Suggestion: Group lists in "Threading Behavior" section by object type

Open
#2,194 1 comment 0 reactions 1 assignee View on GitHub

@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 buffer parameter in vkBindBufferMemory
    • The buffer parameter in vkDestroyBuffer
  • VkImage
    • The image parameter in vkBindImageMemory
    • The image parameter 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.