From cc61a3e600071b217dd41dd2cda23fbca34eb9f9 Mon Sep 17 00:00:00 2001 From: bobo Date: Fri, 29 Mar 2024 19:14:50 +0800 Subject: [PATCH] docs: Add input field descriptions to commands - Include `input: required` in the YAML of various commands - Clarify the necessity of user input in workflow executions - Ensure workflow documentation is comprehensive and clear --- comments/command.yml | 1 + docstring/command.yml | 1 + explain/command.yml | 1 + fix/command.yml | 1 + unit_tests/command.yml | 1 + 5 files changed, 5 insertions(+) diff --git a/comments/command.yml b/comments/command.yml index da10c2f..44fe7e4 100644 --- a/comments/command.yml +++ b/comments/command.yml @@ -1,3 +1,4 @@ description: Automatically add doc comments. Select some code and execute this command to generate comments. +input: required steps: - run: $devchat_python $command_path/main.py diff --git a/docstring/command.yml b/docstring/command.yml index b4f665c..7ac9d38 100644 --- a/docstring/command.yml +++ b/docstring/command.yml @@ -1,3 +1,4 @@ description: Automatically add docstrings. Select a function or method and execute this command to generate docstring. +input: required steps: - run: $devchat_python $command_path/main.py diff --git a/explain/command.yml b/explain/command.yml index d62c908..ef9b949 100644 --- a/explain/command.yml +++ b/explain/command.yml @@ -1,3 +1,4 @@ description: Explain selected code. +input: required steps: - run: $devchat_python $command_path/explain.py diff --git a/fix/command.yml b/fix/command.yml index ddee5a8..d511c58 100644 --- a/fix/command.yml +++ b/fix/command.yml @@ -1,3 +1,4 @@ description: Try to find out potential bugs in the selected code and try fixing these bugs automaticly. +input: required steps: - run: $devchat_python $command_path/main.py diff --git a/unit_tests/command.yml b/unit_tests/command.yml index c967862..731ec0d 100644 --- a/unit_tests/command.yml +++ b/unit_tests/command.yml @@ -1,3 +1,4 @@ description: Generate unit tests. +input: required steps: - run: $devchat_python $command_path/main.py "$input" \ No newline at end of file