docs: update doctor help text

algorandfoundation · Mar 29, 2023 · 111bf2e · 111bf2e
1 parent 7179eb8
commit 111bf2e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/docs/features/doctor.md b/docs/features/doctor.md
@@ -4,9 +4,9 @@ The AlgoKit Doctor feature allows you to check your AlgoKit installation along w
 
 ## Functionality
 
-The AlgoKit Doctor allows you to make sure that your system has the correct dependencies installed and they satisfy the minimum required versions. All passed checks will appear in your command line natural color while warnings will be in yellow (warning) and errors or missing critical services will be in red (error). The critical services that AlgoKit will check for (since they are [directly used by certain commands](../../README.md#prerequisites)): Docker, docker compose and git.
+The AlgoKit Doctor allows you to make sure that your system has the correct dependencies installed and that they satisfy the minimum required versions. All passed checks will appear in your command line natural color while warnings will be in yellow (warning) and errors or missing critical services will be in red (error). The critical services that AlgoKit will check for (since they are [directly used by certain commands](../../README.md#prerequisites)): Docker, docker compose and git.
 
-Please run this command to if you are facing a issue running AlgoKit. It is recommend to run it before [submitting an issue to AlgoKit](https://github.com/algorandfoundation/algokit-cli/issues/new). You can copy the contents of the Doctor command message (in Markdown format) to your clipboard by providing the `-c` flag to the command as follows `algokit doctor -c`.
+Please run this command to if you are facing an issue running AlgoKit. It is recommended to run it before [submitting an issue to AlgoKit](https://github.com/algorandfoundation/algokit-cli/issues/new). You can copy the contents of the Doctor command message (in Markdown format) to your clipboard by providing the `-c` flag to the command as follows `algokit doctor -c`.
 
 # Examples
 

diff --git a/src/algokit/cli/doctor.py b/src/algokit/cli/doctor.py
@@ -22,7 +22,7 @@
 
 @click.command(
     "doctor",
-    short_help="Run the Algorand doctor CLI.",
+    short_help="Diagnose potential environment issues that may affect AlgoKit",
     context_settings={
         "ignore_unknown_options": True,
     },
@@ -35,6 +35,10 @@
     default=False,
 )
 def doctor_command(*, copy_to_clipboard: bool) -> None:
+    """Diagnose potential environment issues that may affect AlgoKit
+
+    Will search the system for AlgoKit dependencies and show their versions, as well as identifying any
+    potential issues."""
     os_type = platform.system()
     is_windows = os_type == "Windows"
     service_outputs = {

diff --git a/tests/doctor/test_doctor.test_doctor_help.approved.txt b/tests/doctor/test_doctor.test_doctor_help.approved.txt
@@ -1,5 +1,10 @@
 Usage: algokit doctor [OPTIONS]
 
+  Diagnose potential environment issues that may affect AlgoKit
+
+  Will search the system for AlgoKit dependencies and show their versions, as
+  well as identifying any potential issues.
+
 Options:
   -c, --copy-to-clipboard  Copy the contents of the doctor message (in Markdown
                            format) in your clipboard.

diff --git a/tests/test_root.test_help.approved.txt b/tests/test_root.test_help.approved.txt
@@ -17,7 +17,7 @@ Commands:
   bootstrap    Bootstrap local dependencies in an AlgoKit project.
   completions  Install and Uninstall AlgoKit shell integration.
   config       Configure AlgoKit options.
-  doctor       Run the Algorand doctor CLI.
+  doctor       Diagnose potential environment issues that may affect AlgoKit
   explore      Explore the specified network in the browser using Dappflow.
   goal         Run the Algorand goal CLI against the AlgoKit LocalNet.
   init         Initializes a new project.