diff options
| author | Dmitry Gutov | 2020-07-12 03:39:16 +0300 |
|---|---|---|
| committer | Dmitry Gutov | 2020-07-12 03:39:16 +0300 |
| commit | ebcbd50c5371dd41dd66eebe4ae525e8ce43df10 (patch) | |
| tree | 72300fd6dc9816b894b6d57b4b4538a1098dae9b | |
| parent | e6e5ce35614a3f82dd0dfa1f50f5e8f05e403a86 (diff) | |
| download | emacs-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.el | 18 |
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 @@ | |||
| 103 | Each functions on this hook is called in turn with one | 103 | Each functions on this hook is called in turn with one |
| 104 | argument, the directory in which to look, and should return | 104 | argument, the directory in which to look, and should return |
| 105 | either nil to mean that it is not applicable, or a project instance. | 105 | either nil to mean that it is not applicable, or a project instance. |
| 106 | The exact form of the project instance depends on the respective | 106 | The exact form of the project instance is up to each respective |
| 107 | function; for example, the default `project-try-vc' returns a | 107 | function; the only practical limitation is to use values that |
| 108 | cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).") | 108 | `cl-defmethod' can dispatch on, like a cons cell, or a list, or a |
| 109 | CL 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'. |
| 116 | When no project is found in that directory, and MAYBE-PROMPT | 117 | When no project is found in that directory, and MAYBE-PROMPT is |
| 117 | is non-nil, ask the user for a directory in which to look for the project. | 118 | non-nil, ask the user for a directory in which to look for the |
| 118 | If no project is found, return nil. | 119 | project; if no project is found there, return a \"transient\" |
| 120 | instance. | ||
| 119 | 121 | ||
| 120 | See the doc string of `project-find-functions' for the form of the | 122 | See the doc string of `project-find-functions' for the form of the |
| 121 | project instance object." | 123 | project instance object." |
| @@ -813,9 +815,7 @@ Arguments the same as in `compile'." | |||
| 813 | This function prompts for another buffer, offering as candidates | 815 | This function prompts for another buffer, offering as candidates |
| 814 | buffers that belong to the same project as the current buffer. | 816 | buffers that belong to the same project as the current buffer. |
| 815 | Two buffers belong to the same project if their project instances, | 817 | Two buffers belong to the same project if their project instances, |
| 816 | as reported by `project-current' in each buffer, are identical. See | 818 | as reported by `project-current' in each buffer, are identical." |
| 817 | the doc string of `project-find-functions' for the forms a project | ||
| 818 | instance 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)) |