docs: outline new comment ID behaviour

Codex- · Oct 25, 2023 · f441ad5 · f441ad5
1 parent e60087b
commit f441ad5
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -22,12 +22,12 @@ steps:
 
 The following inputs are supported
 
-| Input                 | Description                                           | Required | Default                                |
-| --------------------- | ----------------------------------------------------- | -------- | -------------------------------------- |
-| `token`               | GitHub Personal Access Token for making API requests. | `false`  | `${{ github.token }}`                  |
-| `command_script_name` | The package script that runs knip.                    | `false`  | `knip`                                 |
-| `comment_id`          | ID to use when updating the PR comment.               | `false`  | `${{ github.workflow }}-knip-reporter` |
-| `ignore_result`       | Do not fail the action run if knip results are found. | `false`  | `false`                                |
+| Input                 | Description                                                                  | Required | Default                                |
+| --------------------- | ---------------------------------------------------------------------------- | -------- | -------------------------------------- |
+| `token`               | GitHub Personal Access Token for making API requests.                        | `false`  | `${{ github.token }}`                  |
+| `command_script_name` | The package script that runs knip.                                           | `false`  | `knip`                                 |
+| `comment_id`          | ID to use when updating the PR comment. Spaces will be replaced with dashes. | `false`  | `${{ github.workflow }}-knip-reporter` |
+| `ignore_result`       | Do not fail the action run if knip results are found.                        | `false`  | `false`                                |
 
 ### Issues