Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix task status and add more explanation for failure reasoning #833

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

wintonzheng
Copy link
Contributor

@wintonzheng wintonzheng commented Sep 16, 2024

🚀 This description was created by Ellipsis for commit 1070124

docs: update task status and failure reason explanations

Summary:

Update task status values and expand failure reason explanations in api-spec.mdx.

Key points:

  • Task Status: Updated status values in api-spec.mdx to include: created, queued, running, completed, terminated, failed, canceled. Added detailed explanations for each status value.
  • Failure Reason: Expanded failure_reason descriptions in api-spec.mdx with examples and explanations for common failure scenarios.

Generated with ❤️ by ellipsis.dev

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 45385b2 in 11 seconds

More details
  • Looked at 25 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/running-tasks/api-spec.mdx:110
  • Draft comment:
    The task_id format has been updated to tsk_123 in the PR, but there are other instances in the documentation that still use the old format t_123. Consider updating them for consistency.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment is relevant because it addresses a change made in the diff, specifically the format of task_id. Ensuring consistency in documentation is important for clarity. The comment is actionable as it suggests checking other instances of task_id format in the documentation.
    The comment could be seen as not directly related to a code change but rather a documentation consistency issue. However, since the format change is part of the diff, it is relevant.
    The comment is about a change made in the diff and suggests an actionable improvement, which aligns with the rules for keeping comments.
    The comment should be kept as it addresses a change made in the diff and suggests an actionable improvement for documentation consistency.

Workflow ID: wflow_hkihg9WadzzbPOpR


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 1070124 in 13 seconds

More details
  • Looked at 26 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/running-tasks/api-spec.mdx:110
  • Draft comment:
    The task_id format is inconsistent. It is shown as tsk_123 here but as t_123456 elsewhere. Consider standardizing the format across the documentation for consistency.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The task_id format is inconsistent across the documentation. It should be standardized for clarity.
2. docs/running-tasks/api-spec.mdx:117
  • Draft comment:
    The description for action_screenshot_urls contains a typo: "lastest" should be "latest". Also, consider clarifying that these are the screenshots for the last three actions taken by Skyvern.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The description for action_screenshot_urls is unclear and contains a typo.

Workflow ID: wflow_QtdQYfFrNjwTnmVq


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@wintonzheng wintonzheng merged commit e280e9a into main Sep 16, 2024
2 checks passed
@wintonzheng wintonzheng deleted the shu/fix_task_status_doc branch September 16, 2024 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant