Skip to content

docs: add timeout priority order#755

Merged
9aoy merged 1 commit intomainfrom
docs/timeout-priority
Dec 11, 2025
Merged

docs: add timeout priority order#755
9aoy merged 1 commit intomainfrom
docs/timeout-priority

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Dec 11, 2025

Summary

docs: add timeout priority order

Related Links

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 11, 2025 02:58
@netlify
Copy link
Copy Markdown

netlify bot commented Dec 11, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit 71ac3e6
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/693a335413270b0007e356c2
😎 Deploy Preview https://deploy-preview-755--rstest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@9aoy 9aoy merged commit def7347 into main Dec 11, 2025
21 checks passed
@9aoy 9aoy deleted the docs/timeout-priority branch December 11, 2025 03:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds documentation about the priority order for timeout configuration in Rstest. The documentation clarifies how the testing framework determines which timeout value to use when multiple sources specify timeout values.

  • Adds priority order documentation for both test timeouts and hook timeouts
  • Documents the 5-level priority hierarchy from most specific (per-test configuration) to least specific (default value)
  • Provides bilingual documentation in both English and Chinese

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
website/docs/en/config/test/test-timeout.mdx Adds English documentation for test timeout priority order with 5 levels of configuration hierarchy
website/docs/en/config/test/hook-timeout.mdx Adds English documentation for hook timeout priority order with 5 levels of configuration hierarchy
website/docs/zh/config/test/test-timeout.mdx Adds Chinese documentation for test timeout priority order with complete markdown links
website/docs/zh/config/test/hook-timeout.mdx Adds Chinese documentation for hook timeout priority order with complete markdown links

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Rstest determines the test timeout based on the following priority order:

1. [timeout](/api/test-api/test#test-1) configuration in each test case
2. Timeout configured in the test file via [`rstest.setConfig({ testTimeout })`]
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

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

The markdown link is incomplete and missing the URL reference. The link text is present but the URL in parentheses is missing. This should follow the same pattern as line 30 and include the full link like: (/api/rstest/utilities#rstestsetconfig)

Suggested change
2. Timeout configured in the test file via [`rstest.setConfig({ testTimeout })`]
2. Timeout configured in the test file via [`rstest.setConfig({ testTimeout })`](/api/rstest/utilities#rstestsetconfig)

Copilot uses AI. Check for mistakes.
Rstest determines the hook timeout based on the following priority order:

1. [timeout](/api/test-api/hooks) configuration in each test case
2. Timeout configured in the test file via [`rstest.setConfig({ hookTimeout })`]
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

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

The markdown link is incomplete and missing the URL reference. The link text is present but the URL in parentheses is missing. This should follow the same pattern as line 30 and include the full link like: (/api/rstest/utilities#rstestsetconfig)

Suggested change
2. Timeout configured in the test file via [`rstest.setConfig({ hookTimeout })`]
2. Timeout configured in the test file via [`rstest.setConfig({ hookTimeout })`](/api/rstest/utilities#rstestsetconfig)

Copilot uses AI. Check for mistakes.
@9aoy 9aoy mentioned this pull request Dec 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants