[Doc] Fix compound types doc#767
Conversation
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6f59cabc11
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| - **`@qd.data_oriented` containers** must be passed via `qd.Template` (or be the `self` of a `@qd.kernel` method on a `@qd.data_oriented` class). Using a typed-dataclass annotation on the outermost arg errors. | ||
| | Kernel parameter compound type | Annotation | | ||
| | `@dataclasses.dataclass` | `MyDataclass` (dataclass type) | |
There was a problem hiding this comment.
The new table goes directly from the header to the first data row, so Markdown/MyST will not recognize it as a table; readers will see the raw pipe-delimited text instead of the intended annotation matrix. Please add a delimiter row such as |---|---| before this row.
Useful? React with 👍 / 👎.
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| | Kernel parameter compound type | Annotation | | ||
| | `@dataclasses.dataclass` | `MyDataclass` (dataclass type) | | ||
| | `@qd.data_oriented` | `qd.Template` | |
There was a problem hiding this comment.
The markdown table is missing the required separator row between the header and data rows. Without the separator row (e.g., |---|---|), the table will not render correctly.
The table should be:
| Kernel parameter compound type | Annotation |
|---|---|
| `@dataclasses.dataclass` | `MyDataclass` (dataclass type) |
| `@qd.data_oriented` | `qd.Template` || | Kernel parameter compound type | Annotation | | |
| | `@dataclasses.dataclass` | `MyDataclass` (dataclass type) | | |
| | `@qd.data_oriented` | `qd.Template` | | |
| | Kernel parameter compound type | Annotation | | |
| |--------------------------------|------------------------------| | |
| | `@dataclasses.dataclass` | `MyDataclass` (dataclass type) | | |
| | `@qd.data_oriented` | `qd.Template` | | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
1 participant
Issue: #
Brief Summary
copilot:summary
Walkthrough
copilot:walkthrough