Skip to content

Commit

Permalink
docs: improve descriptions and fix typos (#777)
Browse files Browse the repository at this point in the history
  • Loading branch information
wellwelwel authored Sep 17, 2024
1 parent 4c84c34 commit 852f5c4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ deno run npm:poku
<td><a href="https://poku.io/docs/documentation/helpers/skip">skip</a></td>
<td>⏭️ Skip tests when necessary.</td>
</tr>
<tr>
<td><a href="https://poku.io/docs/documentation/helpers/only">only</a></td>
<td>🌌 Debug tests by enabling selective runs.</td>
</tr>
<tr>
<td><a href="https://poku.io/docs/documentation/helpers/processes/get-pids">getPIDs</a></td>
<td>🕵🏻 Debug processes IDs using ports and port ranges.</td>
Expand Down
6 changes: 3 additions & 3 deletions website/docs/documentation/helpers/only.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `.only` helper enables selective execution of tests, allowing you to focus o
<Stability
level={1}
message={
'This method can be altered according to suggestions and difficulties from users.'
"This method can be changed according to users' suggestions and needs. Major changes in this method won't be considered breaking changes while it's in experimental stage."
}
/>

Expand Down Expand Up @@ -187,7 +187,7 @@ It's important to recall that **Poku** respects conventional **JavaScript** synt

### `.only` vs. scope

If a `.only` method is inside an skipped method, it won't be executed, for example:
If a `.only` method is inside a skipped method, it won't be executed, for example:

```ts
import { describe, it, test } from 'poku';
Expand Down Expand Up @@ -296,7 +296,7 @@ As the `describe` method isn't using the `.only` helper, it will be skipped, inc
### `--only=it`

```ts
import { describe, it, test, assert } from 'poku';
import { describe, it, test, assert, beforeEach, afterEach } from 'poku';

beforeEach(() => {
// It will run normally before all `it.only` and `test.only`.
Expand Down

0 comments on commit 852f5c4

Please sign in to comment.