diff options
author | Bastien Guerry <bzg@altern.org> | 2013-02-28 00:28:17 +0100 |
---|---|---|
committer | Bastien Guerry <bzg@altern.org> | 2013-02-28 00:28:17 +0100 |
commit | f4fc83ec642cae8a844d12f2a9049e4567bc29fd (patch) | |
tree | c5e63c39dd404fdd622e9746fff56b1b7f4d9800 | |
parent | db750eba2820492ce28fb6078dbcd8f154f9d725 (diff) | |
download | org-mode-f4fc83ec642cae8a844d12f2a9049e4567bc29fd.tar.gz |
org-protocol.el: Small docstrings enhancements
* org-protocol.el (org-protocol-create-for-org)
(org-protocol-create): Small docstrings enhancements.
-rw-r--r-- | lisp/org-protocol.el | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el index 397597d..2a804ad 100644 --- a/lisp/org-protocol.el +++ b/lisp/org-protocol.el @@ -561,9 +561,9 @@ as filename." (defun org-protocol-create-for-org () "Create a org-protocol project for the current file's Org-mode project. -This works, if the file visited is part of a publishing project in -`org-publish-project-alist'. This function calls `org-protocol-create' to do -most of the work." +The visited file needs to be part of a publishing project in +`org-publish-project-alist' for this to work. The function +delegates most of the work to `org-protocol-create'." (interactive) (require 'org-publish) (let ((all (or (org-publish-get-project-from-filename buffer-file-name)))) @@ -573,10 +573,11 @@ most of the work." (defun org-protocol-create (&optional project-plist) "Create a new org-protocol project interactively. -An org-protocol project is an entry in `org-protocol-project-alist' -which is used by `org-protocol-open-source'. -Optionally use project-plist to initialize the defaults for this project. If -project-plist is the CDR of an element in `org-publish-project-alist', reuse +An org-protocol project is an entry in +`org-protocol-project-alist' which is used by +`org-protocol-open-source'. Optionally use PROJECT-PLIST to +initialize the defaults for this project. If PROJECT-PLIST is +the cdr of an element in `org-publish-project-alist', reuse :base-directory, :html-extension and :base-extension." (interactive) (let ((working-dir (expand-file-name |