From 32a70c01385d3255c5bce9316184b4db15cfbfca Mon Sep 17 00:00:00 2001
From: Zach Allaun <zach.allaun@gmail.com>
Date: Wed, 17 Jul 2024 13:09:49 -0400
Subject: [PATCH] docs: update mix mneme.watch moduledoc

---
 lib/mix/tasks/mneme.watch.ex | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/lib/mix/tasks/mneme.watch.ex b/lib/mix/tasks/mneme.watch.ex
index b67b979..1b6f7b7 100644
--- a/lib/mix/tasks/mneme.watch.ex
+++ b/lib/mix/tasks/mneme.watch.ex
@@ -6,11 +6,28 @@ defmodule Mix.Tasks.Mneme.Watch do
   This task is similar to [`mix test.watch`](https://hex.pm/packages/mix_test_watch),
   but updated to work with Mneme:
 
-    * interrupts Mneme prompts, saving out already-accepted changes
-    * tests aren't re-triggered when Mneme saves a test file after an
-      update
+    * interrupts Mneme prompts, saving already-accepted changes
+    * doesn't re-trigger when test files are updated by Mneme
 
-  This task accepts the same arguments as `mix test`. For instance:
+  ## Setup
+
+  To ensure `mix mneme.watch` runs in the test environment, add a
+  `:preferred_cli_env` entry in `mix.exs`:
+
+      def project do
+        [
+          ...
+          preferred_cli_env: [
+            "mneme.watch": :test
+          ],
+          ...
+        ]
+      end
+
+  ## Command line options
+
+  This task runs `mix test` under the hood and passes all CLI arguments
+  to it directly. For instance:
 
   ```sh
   # only run tests tagged with `some_tag: true`
@@ -19,6 +36,8 @@ defmodule Mix.Tasks.Mneme.Watch do
   # only run tests from one file
   $ mix mneme.watch test/my_app/my_test.exs
   ```
+
+  See the `mix test` documentation for more information.
   """
 
   use Mix.Task