Refactor code generation for public API #135
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 tasks
almarklein
commented
Mar 29, 2021
Comment on lines
+61
to
+67
| .. autodata:: wgpu.base.apidiff | ||
| :annotation: Differences of base API: | ||
|
|
||
|
|
||
| .. autodata:: wgpu.backends.rs.apidiff | ||
| :annotation: Differences of rs backend: | ||
|
|
There was a problem hiding this comment.
I'm really happy about this part. The codegen enforces exactly the WebGPU API, except where methods are decorated. And all decorations are collected and end up here in the docs!
almarklein
changed the title
|
Looks great! I don't have time to go through it with a fine comb, sorry. I trust we will identify any issues soon enough anyway :) |
|
Yeah, these changes are somehow hard to review. We could go over the code in a meeting once it has progressed further. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the first step in the codegen refactoring in #135. It changes how the API is created. The public API
base.pyis fully defined from the WebGPU spec (IDL), not from the C header. The backend implementationsrs.pyis defined frombase.py. Any deviations from the "reference" API must be marked with decorators, making them explicit (and document-able).I'll focus on handling of the C-header in later PR(s).