Skip to content

docs: add alias for rstest utility API#447

Merged
9aoy merged 1 commit intomainfrom
docs/rstest-alias
Aug 5, 2025
Merged

docs: add alias for rstest utility API#447
9aoy merged 1 commit intomainfrom
docs/rstest-alias

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Aug 5, 2025

Summary

add alias for rstest utility API.

Related Links

Checklist

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

Copilot AI review requested due to automatic review settings August 5, 2025 10:18
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 alias documentation for the rstest utility API, introducing rs.* as shorter aliases for all rstest.* functions across the API documentation.

  • Adds alias entries for all utility functions, mock functions, and fake timer functions
  • Maintains consistency across both English and Chinese documentation
  • Provides a more concise way to access rstest APIs using the rs prefix

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/docs/zh/api/rstest/utilities.mdx Adds Chinese alias documentation for utility functions like stubEnv, stubGlobal, setConfig
website/docs/zh/api/rstest/mockFunctions.mdx Adds Chinese alias documentation for mock-related functions like fn, spyOn, clearAllMocks
website/docs/zh/api/rstest/fakeTimers.mdx Adds Chinese alias documentation for timer-related functions like useFakeTimers, advanceTimersByTime
website/docs/en/api/rstest/utilities.mdx Adds English alias documentation for utility functions
website/docs/en/api/rstest/mockFunctions.mdx Adds English alias documentation for mock-related functions
website/docs/en/api/rstest/fakeTimers.mdx Adds English alias documentation for timer-related functions

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 5, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit f951f44
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/6891da7d416a890008efe7d4
😎 Deploy Preview https://deploy-preview-447--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 72f3fd7 into main Aug 5, 2025
17 checks passed
@9aoy 9aoy deleted the docs/rstest-alias branch August 5, 2025 11:10
@9aoy 9aoy mentioned this pull request Aug 6, 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