Revise docstrings for doom-project-{root,p}

This commit is contained in:
Henrik Lissner 2018-02-06 17:30:03 -05:00
parent 4658d22bf7
commit 508dbf7a5c
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -68,16 +68,16 @@ you want to interactive with a project other than the one you're in."
(remhash (format "%s-%s" fn default-directory) projectile-project-root-cache))) (remhash (format "%s-%s" fn default-directory) projectile-project-root-cache)))
(defun doom-project-p (&optional nocache) (defun doom-project-p (&optional nocache)
"Whether or not this buffer is currently in a project or not." "Return t if this buffer is currently in a project.
If NOCACHE, don't fetch a cached answer."
(if nocache (if nocache
(without-project-cache! (doom-project-p nil)) (without-project-cache! (doom-project-p nil))
(let ((projectile-require-project-root t)) (let ((projectile-require-project-root t))
(projectile-project-p)))) (projectile-project-p))))
(defun doom-project-root (&optional nocache) (defun doom-project-root (&optional nocache)
"Get the path to the root of your project. "Returns the root of your project, or `default-directory' if none was found.
If STRICT-P, return nil if no project was found, otherwise return If NOCACHE, don't fetch a cached answer."
`default-directory'."
(if nocache (if nocache
(without-project-cache! (doom-project-root nil)) (without-project-cache! (doom-project-root nil))
(let (projectile-require-project-root) (let (projectile-require-project-root)