aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDmitry Gutov2020-07-12 03:39:16 +0300
committerDmitry Gutov2020-07-12 03:39:16 +0300
commitebcbd50c5371dd41dd66eebe4ae525e8ce43df10 (patch)
tree72300fd6dc9816b894b6d57b4b4538a1098dae9b
parente6e5ce35614a3f82dd0dfa1f50f5e8f05e403a86 (diff)
downloademacs-ebcbd50c5371dd41dd66eebe4ae525e8ce43df10.tar.gz
emacs-ebcbd50c5371dd41dd66eebe4ae525e8ce43df10.zip
More docstring updates in project.el
* lisp/progmodes/project.el (project-find-functions) (project-current, project-switch-to-buffer): More docstring updates.
-rw-r--r--lisp/progmodes/project.el18
1 files changed, 9 insertions, 9 deletions
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index af02af7cc55..293ef0b3508 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -103,9 +103,10 @@
103Each functions on this hook is called in turn with one 103Each functions on this hook is called in turn with one
104argument, the directory in which to look, and should return 104argument, the directory in which to look, and should return
105either nil to mean that it is not applicable, or a project instance. 105either nil to mean that it is not applicable, or a project instance.
106The exact form of the project instance depends on the respective 106The exact form of the project instance is up to each respective
107function; for example, the default `project-try-vc' returns a 107function; the only practical limitation is to use values that
108cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).") 108`cl-defmethod' can dispatch on, like a cons cell, or a list, or a
109CL struct.")
109 110
110(defvar project-current-inhibit-prompt nil 111(defvar project-current-inhibit-prompt nil
111 "Non-nil to skip prompting the user in `project-current'.") 112 "Non-nil to skip prompting the user in `project-current'.")
@@ -113,9 +114,10 @@ cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).")
113;;;###autoload 114;;;###autoload
114(defun project-current (&optional maybe-prompt directory) 115(defun project-current (&optional maybe-prompt directory)
115 "Return the project instance in DIRECTORY, defaulting to `default-directory'. 116 "Return the project instance in DIRECTORY, defaulting to `default-directory'.
116When no project is found in that directory, and MAYBE-PROMPT 117When no project is found in that directory, and MAYBE-PROMPT is
117is non-nil, ask the user for a directory in which to look for the project. 118non-nil, ask the user for a directory in which to look for the
118If no project is found, return nil. 119project; if no project is found there, return a \"transient\"
120instance.
119 121
120See the doc string of `project-find-functions' for the form of the 122See the doc string of `project-find-functions' for the form of the
121project instance object." 123project instance object."
@@ -813,9 +815,7 @@ Arguments the same as in `compile'."
813This function prompts for another buffer, offering as candidates 815This function prompts for another buffer, offering as candidates
814buffers that belong to the same project as the current buffer. 816buffers that belong to the same project as the current buffer.
815Two buffers belong to the same project if their project instances, 817Two buffers belong to the same project if their project instances,
816as reported by `project-current' in each buffer, are identical. See 818as reported by `project-current' in each buffer, are identical."
817the doc string of `project-find-functions' for the forms a project
818instance object can take."
819 (interactive) 819 (interactive)
820 (let* ((pr (project-current t)) 820 (let* ((pr (project-current t))
821 (current-buffer (current-buffer)) 821 (current-buffer (current-buffer))