Add documentation for auto-start

rejeep · Dec 3, 2017 · 3034149 · 3034149
1 parent e3bf2e6
commit 3034149
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -78,6 +78,11 @@ Services can be defined by setting the variable `prodigy-services`:
    (:prop value ...)))
 ```
 
+#### Auto start services
+
+You can auto start some services by setting the `auto-start` property
+to `t`. Then you have **at the end of your prodigy configuration** call the function `(prodigy-auto-start)`
+
 ### Viewing process output
 
 In the prodigy window, you can see a process' output with the `$` key.

diff --git a/prodigy.el b/prodigy.el
@@ -1206,7 +1206,7 @@ started."
 
 
 (defun prodigy-start-auto-start-service (service)
-  "Start service if indicated as auto-service."
+  "Start service if indicated as `auto-start'."
   (interactive)
   (prodigy-with-refresh
    (when (plist-get service :auto-start)
@@ -1442,7 +1442,7 @@ beginning of the line."
 
 ;;;###autoload
 (defun prodigy-auto-start ()
-  "Start service at line or marked services."
+  "Start services whose property `auto-start' is set to `t'."
   (interactive)
   (let ((saved-buffer (current-buffer))
 	(buffer-p (prodigy-buffer))