[Doc] Fix graph doc issues#762
Conversation
Add RULE 3 to the doc-quality agent prompt: within a single doc, information must be ordered so a first-time reader can follow it top-to-bottom without jumping ahead (no forward references). Includes carve-outs for roadmaps, optional "see below" pointers, backward references, cross-doc references, and conventional preamble ordering, and hands pure undefined-term cases to Rule 1. Adds the [order] tag and reworks the violation cap so one rule cannot crowd out the others.
The doc-quality check now enforces a third rule (reading order / no forward references); describe it and its carve-outs in contributing.md.
Both added cognitive load to the agent for little gain. Revert to the original "stop after 10 violations" cap and remove the Rule 1/Rule 3 delineation note.
…to hp/fixup-graph-doc
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # docs/source/user_guide/contributing.md
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
Per review, streams/fastcache/perf_dispatch do not reduce launch latency. Keep only graphs under "Reducing launch latency" and move the others to a new "Other performance tools" section.
|
@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: 8865124849
ℹ️ 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".
Cached graph replay collapses per-task C++/driver launch cost, but the Python kernel wrapper still runs on every call; only graph_do_while cuts the per-call Python cost by turning many iterations into one call.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38c8ad1ecb
ℹ️ 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".
Intro said all four tools reduce launch latency, contradicting the "Other performance tools" section; reframe them as performance tools built on the execution model.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d950487304
ℹ️ 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".
Previously stream_parallel groups inside a graph kernel were silently serialized rather than rejected, so users could combine two mutually incompatible features without warning. Raise a QuadrantsSyntaxError at compile time instead, and document that streams (both qd_stream and qd.stream_parallel) are incompatible with graphs.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cb8bca0bd2
ℹ️ 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".
The doc-quality check reviews the full file once touched; qd.ad.Tape was flagged as an undefined term. Link it (and "autodiff") to autodiff.md.
Doc-quality check flagged graph=True as an undefined term once streams.md was touched; link it (and "graphs") to graph.md.
The restriction applies to any return value (result_buffer_size > 0), not just struct returns; "struct" is the internal representation and misleads readers. Say "No return values" instead.
2 participants
Issue: #
Brief Summary
copilot:summary
Walkthrough
copilot:walkthrough