Commit f5bc508b authored by Eli Zaretskii's avatar Eli Zaretskii

Fix last doc changes in project.el

* lisp/progmodes/project.el (project-find-functions)
(project-current): Add back information which was recently
removed.
parent 45d7db6d
Pipeline #6042 failed with stage
in 12 seconds
......@@ -106,7 +106,8 @@ either nil to mean that it is not applicable, or a project instance.
The exact form of the project instance is up to each respective
function; the only practical limitation is to use values that
`cl-defmethod' can dispatch on, like a cons cell, or a list, or a
CL struct.")
CL struct. For example, the default `project-try-vc' returns a
cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).")
(defvar project-current-inhibit-prompt nil
"Non-nil to skip prompting the user in `project-current'.")
......@@ -114,13 +115,16 @@ CL struct.")
;;;###autoload
(defun project-current (&optional maybe-prompt directory)
"Return the project instance in DIRECTORY, defaulting to `default-directory'.
When no project is found in that directory, and MAYBE-PROMPT is
non-nil, ask the user for a directory in which to look for the
project; if no project is found there, return a \"transient\"
instance.
See the doc string of `project-find-functions' for the form of the
project instance object."
When no project is found in that directory, the result depends
on the value of MAYBE-PROMPT: if it is nil or omitted, return nil,
else ask the user for a directory in which to look for the
project, and if no project is found there, return a \"transient\"
project instance. The \"transient\" project instance is a special
project object whose form is (transient DIRECTORY), and that can be
used as a basis for creating a project in that directory.
See the doc string of `project-find-functions' for the general form
of the project instance object."
(unless directory (setq directory default-directory))
(let ((pr (project--find-in-directory directory)))
(cond
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment