Add docs to Guardfile

rubymonolith · Jul 24, 2023 · cfd77a8 · cfd77a8
1 parent fd94cb5
commit cfd77a8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/guard/zeitwerk/templates/Guardfile b/lib/guard/zeitwerk/templates/Guardfile
@@ -1,4 +1,7 @@
 # Watches all Ruby files in a project.
+#
+# The `require:` parameter is configured for a Rails project. If using it for
+# a gem, change the require path to whatever loads a Zeitwerk::Autoloader.
 guard :zeitwerk, require: "config/application.rb" do
   watch(/.*\.rb$/)
 end