From e3f186671f8f62edf139d0b796d624fe986f2cf1 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:17:50 +0100 Subject: [PATCH 1/4] Clear up the automated comment --- .github/workflows/command-block.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index c886fd95560..404afe371a2 100644 --- a/.github/workflows/command-block.yml +++ b/.github/workflows/command-block.yml @@ -17,9 +17,11 @@ 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'+ - '- If you already updated the command help, you are already done!\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\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'+ + '- If you accidentally made a change in `commands/` while working on general documentation, please revert changes to `commands/`\n\n'+ 'Thanks for helping out!' }) - run: | From 9891d01a3434ac569a3c75d19fabb82fee5918bb Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:19:20 +0100 Subject: [PATCH 2/4] Make a triggering change --- commands/docs/alias.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/commands/docs/alias.md b/commands/docs/alias.md index a58b552b7f5..5a8937dc5cb 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -20,6 +20,7 @@ usage: | ## Parameters +Troll - `name`: Name of the alias. - `initial_value`: Equals sign followed by value. @@ -40,4 +41,4 @@ Alias ll to ls -l ## Notes This command is a parser keyword. For details, check: - https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file + https://www.nushell.sh/book/thinking_in_nu.html From a71c4bc118731b946492bb75952f8d4cf89b0790 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:21:09 +0100 Subject: [PATCH 3/4] Revert "Make a triggering change" This reverts commit 9891d01a3434ac569a3c75d19fabb82fee5918bb. --- commands/docs/alias.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 5a8937dc5cb..a58b552b7f5 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -20,7 +20,6 @@ usage: | ## Parameters -Troll - `name`: Name of the alias. - `initial_value`: Equals sign followed by value. @@ -41,4 +40,4 @@ Alias ll to ls -l ## Notes This command is a parser keyword. For details, check: - https://www.nushell.sh/book/thinking_in_nu.html + https://www.nushell.sh/book/thinking_in_nu.html \ No newline at end of file From 22210ed1581a226a8417ba1bd5e06e46055bd245 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Mon, 23 Dec 2024 00:24:55 +0100 Subject: [PATCH 4/4] Further refinement --- .github/workflows/command-block.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/command-block.yml b/.github/workflows/command-block.yml index 404afe371a2..7874e64dd2d 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!' })