docs: PI v2.7 - pretask#1309
Open
MistEO wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈:
- 在
pretask.option的描述中,建议显式说明序列化 JSON 参数的编码和转义方面的预期(例如 UTF-8、shell 转义规则),这样可以确保不同平台上的客户端实现行为一致。 - 对于
pretask字段是object | object[]的情况,可以加一句简短说明:单个对象等价于只包含该对象的单元素数组,这样客户端和 PI 作者就能对如何规范化和执行多个 pre-task 有明确、一致的预期。
面向 AI 代理的提示词
Please address the comments from this code review:
## Overall Comments
- In the `pretask.option` description, consider explicitly specifying the encoding and escaping expectations for the serialized JSON argument (e.g., UTF-8, shell-escaping rules) so client implementations across platforms behave consistently.
- For the `pretask` field being `object | object[]`, it may help to add a short note stating that a single object is treated equivalently to a single-element array so clients and PI authors have an unambiguous expectation for how multiple pre-tasks are normalized and executed.帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've left some high level feedback:
- In the
pretask.optiondescription, consider explicitly specifying the encoding and escaping expectations for the serialized JSON argument (e.g., UTF-8, shell-escaping rules) so client implementations across platforms behave consistently. - For the
pretaskfield beingobject | object[], it may help to add a short note stating that a single object is treated equivalently to a single-element array so clients and PI authors have an unambiguous expectation for how multiple pre-tasks are normalized and executed.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the `pretask.option` description, consider explicitly specifying the encoding and escaping expectations for the serialized JSON argument (e.g., UTF-8, shell-escaping rules) so client implementations across platforms behave consistently.
- For the `pretask` field being `object | object[]`, it may help to add a short note stating that a single object is treated equivalently to a single-element array so clients and PI authors have an unambiguous expectation for how multiple pre-tasks are normalized and executed.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
@MaaXYZ/ui-developers @MaaXYZ/application-developers 看看
fix #1308
Summary by Sourcery
为 v2.7.0 新增的
pretask配置撰写文档,用于在 Controller 启动前运行自定义程序,并更新相关配置语义。Build:
pretask配置字段。Documentation:
pretask字段新增英文和中文文档,包括其结构、执行行为以及选项参数序列化语义。pretask.option被排除在标准的选项覆盖/合并顺序之外,并且仅用于为预任务进程生成参数。Original summary in English
Summary by Sourcery
Document the new v2.7.0
pretaskconfiguration for running custom programs before Controller startup and update related configuration semantics.Build:
pretaskconfiguration field.Documentation:
pretaskfield, including its structure, execution behavior, and option argument serialization semantics.pretask.optionis excluded from the standard option override/merge order and is used only to generate arguments for pre-task processes.