Skip to content

Commit 6de3229

Browse files
authored
Clear up the automated comment (#1707)
* Clear up the automated comment * Make a triggering change * Revert "Make a triggering change" This reverts commit 9891d01. * Further refinement
1 parent cf107f0 commit 6de3229

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

.github/workflows/command-block.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ jobs:
1717
owner: context.repo.owner,
1818
repo: context.repo.repo,
1919
body: 'Awesome that you are trying to improve the documentation of a nushell command!\n\n' +
20-
'As we autogenerate these command pages from the help information defined with the command after each release:\n'+
21-
'- If you already updated the command help, you are already done!\n'+
22-
'- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there.\n\n'+
20+
'You should not modify the files in `commands/docs` or `commands/categorees`!\n' +
21+
'We autogenerate these command pages from the `help` information defined by the command implementation, after each release. Thus:\n'+
22+
'- If you already updated the command help, you are already done and can close this PR!\n'+
23+
'- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there in the `impl Command` and `Signature`.\n'+
24+
'- If you accidentally made a change in `commands/` while working on general documentation, please revert changes to `commands/`\n\n'+
2325
'Thanks for helping out!'
2426
})
2527
- run: |

0 commit comments

Comments
 (0)