diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index 404afe371a..7874e64dd2 100644 --- a/.github/workflows/command-block.yml +++ b/.github/workflows/command-block.yml @@ -17,10 +17,10 @@ jobs: owner: context.repo.owner, repo: context.repo.repo, body: 'Awesome that you are trying to improve the documentation of a nushell command!\n\n' + - 'You should not modify the files in `commands/docs` or `commands/categores`\n'+ - 'As we autogenerate these command pages from the help information defined with the command after each release:\n'+ + 'You should not modify the files in `commands/docs` or `commands/categorees`!\n' + + 'We autogenerate these command pages from the `help` information defined by the command implementation, after each release. Thus:\n'+ '- If you already updated the command help, you are already done and can close this PR!\n'+ - '- 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'+ + '- 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'+ '- If you accidentally made a change in `commands/` while working on general documentation, please revert changes to `commands/`\n\n'+ 'Thanks for helping out!' })