Conversation
db6716a to
bf54a9d
Compare
Contributor
There was a problem hiding this comment.
Hey - 我发现了 1 个问题，并且给出了一些总体反馈：
- 内联的
**💡 vX.Y**标记现在散落在整个文档中；建议将其统一标准化为一致的 “Since vX.Y” 模式（例如使用无表情符号的标注或徽章样式），这样能让 Markdown 在不同渲染器中更整洁、更易读。
给 AI 代理的提示
Please address the comments from this code review:
## Overall Comments
- The inline `**💡 vX.Y**` markers are now sprinkled throughout the document; consider standardizing this as a consistent "Since vX.Y" pattern (e.g., a callout or badge style without emoji) to keep the markdown cleaner and more readable across different renderers.
## Individual Comments
### Comment 1
<location path="docs/en_us/3.1-PipelineProtocol.md" line_range="878" />
<code_context>
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
- - *array<int, 2>*: Fixed coordinate point [x, y]. Supports negative values, meaning calculating from right/bottom edge.
- - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values, same meaning as `roi`.
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning calculating from right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, same meaning as `roi`.
</code_context>
<issue_to_address>
**nitpick (typo):** 对负坐标的描述做一个轻微的语法调整。
你可以将最后一句改写为："Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge"，以使语句更加通顺。
Suggested implementation:
```
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
```
```
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, meaning they are calculated in the same way as `roi`.
```
</issue_to_address>帮我变得更有用！请对每条评论点 👍 或 👎，我会根据你的反馈改进后续的 Review。
Original comment in English
Hey - I've found 1 issue, and left some high level feedback:
- The inline
**💡 vX.Y**markers are now sprinkled throughout the document; consider standardizing this as a consistent "Since vX.Y" pattern (e.g., a callout or badge style without emoji) to keep the markdown cleaner and more readable across different renderers.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The inline `**💡 vX.Y**` markers are now sprinkled throughout the document; consider standardizing this as a consistent "Since vX.Y" pattern (e.g., a callout or badge style without emoji) to keep the markdown cleaner and more readable across different renderers.
## Individual Comments
### Comment 1
<location path="docs/en_us/3.1-PipelineProtocol.md" line_range="878" />
<code_context>
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
- - *array<int, 2>*: Fixed coordinate point [x, y]. Supports negative values, meaning calculating from right/bottom edge.
- - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values, same meaning as `roi`.
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning calculating from right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, same meaning as `roi`.
</code_context>
<issue_to_address>
**nitpick (typo):** Slight grammatical tweak in the description of negative coordinates.
You could rephrase the last clause to: "Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge" for smoother grammar.
Suggested implementation:
```
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
```
```
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, meaning they are calculated in the same way as `roi`.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| - *string*: Enter the node name, as the target, to use the position recognized by a previously executed node. | ||
| - *array<int, 2>*: Fixed coordinate point [x, y]. Supports negative values, meaning calculating from right/bottom edge. | ||
| - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values, same meaning as `roi`. | ||
| - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning calculating from right/bottom edge. |
Contributor
There was a problem hiding this comment.
nitpick (typo): 对负坐标的描述做一个轻微的语法调整。
你可以将最后一句改写为："Supports negative values 💡 v5.6, meaning they are calculated from the right/bottom edge"，以使语句更加通顺。
Suggested implementation:
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, meaning they are calculated in the same way as `roi`.
Original comment in English
nitpick (typo): Slight grammatical tweak in the description of negative coordinates.
You could rephrase the last clause to: "Supports negative values 💡 v5.6, meaning they are calculated from the right/bottom edge" for smoother grammar.
Suggested implementation:
- *string*: Enter the node name, as the target, to use the position recognized by a previously executed node.
+ - *array<int, 2>*: Fixed coordinate point [x, y] **💡 v5.0**. Supports negative values **💡 v5.6**, meaning they are calculated from the right/bottom edge.
+ - *array<int, 4>*: Fixed coordinate area [x, y, w, h]. A point is sampled inside the rectangle with higher probability near center. Supports negative values **💡 v5.6**, meaning they are calculated in the same way as `roi`.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Pipeline Protocol documentation to include explicit pipeline-version change notes and inline “since v5.x” markers, improving discoverability of when fields/actions were introduced.
Changes:
- Add a “Version Changes” table summarizing key protocol updates by pipeline version.
- Add inline version annotations (e.g., 💡 v5.3) across relevant fields/actions to indicate introduction/deprecation points.
- Minor formatting adjustments around existing sections to accommodate the new version notes.
|
|
||
| | Version | Changes | | ||
| | ---- | -------- | | ||
| | v5.0 | Added `attach` field; Added `TouchDown`, `TouchMove`, `TouchUp`, `KeyDown`, `KeyUp` actions; Added `contact`, `pressure` fields to Click / LongPress / Swipe / MultiSwipe; `target` supports `[x, y]` binary coordinates | |
There was a problem hiding this comment.
In the v5.0 row, “target supports [x, y] binary coordinates” reads like base-2/binary encoding. This seems to mean a 2-element point coordinate (x,y); please rephrase to avoid misleading terminology and align with the intent of the feature.
Suggested change
| | v5.0 | Added `attach` field; Added `TouchDown`, `TouchMove`, `TouchUp`, `KeyDown`, `KeyUp` actions; Added `contact`, `pressure` fields to Click / LongPress / Swipe / MultiSwipe; `target` supports `[x, y]` binary coordinates | | |
| | v5.0 | Added `attach` field; Added `TouchDown`, `TouchMove`, `TouchUp`, `KeyDown`, `KeyUp` actions; Added `contact`, `pressure` fields to Click / LongPress / Swipe / MultiSwipe; `target` supports two-element `[x, y]` coordinates | |
Comment on lines
+135
to
+136
| ### Version Changes | ||
|
|
There was a problem hiding this comment.
PR description says the version notes were added to the Chinese 3.1 documentation, but this PR changes the English doc file. Please either update the PR description to match the actual change, or include the corresponding zh_cn documentation changes if they’re intended.
This file contains hidden or 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
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.
由 Sourcery 提供的概要
记录 Pipeline 协议版本历史，并为各字段标注其被引入或更改的协议版本。
文档更新：
Original summary in English
Summary by Sourcery
Document pipeline protocol version history and annotate fields with the versions in which they were introduced or changed.
Documentation:
Original summary in English
由 Sourcery 提供的概要
记录 Pipeline 协议版本历史，并为各字段标注其被引入或更改的协议版本。
文档更新：
Original summary in English
Summary by Sourcery
Document pipeline protocol version history and annotate fields with the versions in which they were introduced or changed.
Documentation: