Skip to content

Add testing exports documentation to API docs#2400

Closed
theluckystrike wants to merge 1 commit intoericcornelissen:mainfrom
theluckystrike:fix/2396-testing-docs
Closed

Add testing exports documentation to API docs#2400
theluckystrike wants to merge 1 commit intoericcornelissen:mainfrom
theluckystrike:fix/2396-testing-docs

Conversation

@theluckystrike
Copy link
Copy Markdown

@theluckystrike theluckystrike commented Mar 5, 2026

Adds documentation for the testing exports (injectionStrings, Failscape, Stubscape, Throwscape) to the API documentation. These exports from shescape/testing were not documented in the API docs.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 5, 2026
@deepsource-io

This comment has been minimized.

@ericcornelissen
Copy link
Copy Markdown
Owner

Thanks for taking the time to contribute!

This API is covered in testing.md, if you think there's anything missing please add it there (and revert the changes to api.md). If not, please close this Pull Request.

Also, off-topic, but #2396 was about testing.js (not .md) - which is now already covered by #2399.

@theluckystrike
Copy link
Copy Markdown
Author

Thank you for the clarification! You're right — the testing exports are already well-documented in testing.md. I'll close this PR since it's not needed.

Apologies for the noise, and thanks for maintaining shescape!

@ericcornelissen ericcornelissen added the invalid This doesn't seem right label Mar 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation invalid This doesn't seem right

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants