[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-25 cc140bc: Document user-level functions in project
From: |
Eli Zaretskii |
Subject: |
[Emacs-diffs] emacs-25 cc140bc: Document user-level functions in project.el |
Date: |
Sat, 09 Jan 2016 19:46:29 +0000 |
branch: emacs-25
commit cc140bcec665163790a8a15845f16dca39525425
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>
Document user-level functions in project.el
* lisp/progmodes/project.el (project-find-file)
(project-or-external-find-file): Add doc strings.
---
etc/NEWS | 3 ++-
lisp/progmodes/project.el | 8 ++++++++
2 files changed, 10 insertions(+), 1 deletions(-)
diff --git a/etc/NEWS b/etc/NEWS
index 407d13b..3ad2fb3 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -964,13 +964,14 @@ As a result of this, the following commands are now
obsolete:
The framework's Lisp API is still experimental and can change in major,
backward-incompatible ways.
+---
** New package Project
The new package Project provides generic infrastructure for dealing
with projects. The main commands included in it are
`project-find-file' and `project-find-regexp'.
-Like Xref, the project API is still experimental.
+The Lisp API of this package is still experimental.
*** New variables
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 5070bb0..fe28ed7 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -313,6 +313,10 @@ pattern to search for."
;;;###autoload
(defun project-find-file ()
+ "Visit a file in the current project's roots.
+
+This is like `find-file', but it limits the file-name completion
+candidates to the files within the current project roots."
(interactive)
(let* ((pr (project-current t))
(dirs (project-roots pr)))
@@ -320,6 +324,10 @@ pattern to search for."
;;;###autoload
(defun project-or-external-find-file ()
+ "Visit a file in the current project's roots or external roots.
+
+This is like `find-file', but it limits the file-name completion
+candidates to the files within the current project roots and external roots."
(interactive)
(let* ((pr (project-current t))
(dirs (append
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] emacs-25 cc140bc: Document user-level functions in project.el,
Eli Zaretskii <=