docs: Improved Text Readability in Documentation #2570
Conversation
This file contains 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
tom2drum
requested changes
Feb 11, 2025
| @@ -121,22 +121,22 @@ Every feature or bugfix should be accompanied by tests, either unit tests or com | |||
|
|
|||
| If your changes are only related to the logic of the app and not to its visual presentation, then try to write unit tests using [Jest](https://jestjs.io/) framework and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/). In general these tests are "cheaper" and faster than Playwright ones. Use them for testing your utilities and React hooks, as well as the whole components logic. | |||
|
|
|||
| Place your test suites in `.test.ts` or `.test.tsx` files. You can find or add some mocks or other helpful utilities for these tests purposes in the `/jest` folder. | |||
| Place your test files in `.test.ts` or `.test.tsx`. You can find or add some mocks or other helpful utilities for these tests purposes in the `/jest` folder. | |||
There was a problem hiding this comment.
I believe this phrase is correct. Your suggested option seems less sensible.
There was a problem hiding this comment.
I believe this phrase is correct. Your suggested option seems less sensible.
It replaces "test suites" with "test files" for better accuracy.
There was a problem hiding this comment.
Yes, but you cannot place test files in .test.ts, as it is technically a test file.
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.
Description and Related Issue(s)
I noticed a few minor grammatical issues in the documentation that could affect clarity.
This update fixes them to improve readability and ensure proper phrasing.
Checklist for PR author