Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand StagingBelt documentation. #2905

Merged
merged 1 commit into from
Jul 26, 2022
Merged

Conversation

kpreid
Copy link
Contributor

@kpreid kpreid commented Jul 21, 2022

Checklist

  • Run cargo clippy.
  • Run RUSTFLAGS=--cfg=web_sys_unstable_apis cargo clippy --target wasm32-unknown-unknown if applicable.
  • Add change to CHANGELOG.md. See simple instructions inside file.

Description
Expand StagingBelt documentation:

  • Give advice on the minimum chunk_size, for more efficient memory usage.
  • Explain the state transitions and valid call sequences in more detail.
  • More intra-doc links.

* Give advice on the *minimum* `chunk_size`.
* Explain the state transitions and valid call sequences in more detail.
* More intra-doc links.
@kpreid kpreid marked this pull request as ready for review July 21, 2022 15:06
Copy link
Member

@cwfitzgerald cwfitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very very good stuff

@cwfitzgerald cwfitzgerald enabled auto-merge (squash) July 26, 2022 03:31
@cwfitzgerald cwfitzgerald merged commit 7b48768 into gfx-rs:master Jul 26, 2022
@kpreid kpreid deleted the beltdoc branch September 27, 2022 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants