summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2014-04-26 17:13:15 -0400
committerKyle Meyer <kyle@kyleam.com>2014-04-26 17:22:34 -0400
commit4c2d1ef2ca3e0f0a820193fbb8248833f147c031 (patch)
treef68bb9deb6a7ee18dbc9fb2c454ac366395a8d16
parent1f231c7ba3153e32c689e5d68b43eb11f5ff1ba6 (diff)
downloadbog-4c2d1ef2ca3e0f0a820193fbb8248833f147c031.tar.gz
Clarify some docstrings
-rw-r--r--bog.el9
1 files changed, 5 insertions, 4 deletions
diff --git a/bog.el b/bog.el
index 6cec153..40c952c 100644
--- a/bog.el
+++ b/bog.el
@@ -143,8 +143,9 @@ This is only meaningful if `bog-find-citekey-bib-func' set to
(defcustom bog-citekey-file-name-separators '("-" "_")
"Characters allowed to follow the citekey in file names.
When `bog-find-citekey-file' is run on <citekey>, it will find
-files with the format <citekey><sep>*.<ext>, where <sep> is one
-of the characters in `bog-citekey-file-name-separators'.")
+files with the format <citekey>.* and <citekey><sep>*.<ext>,
+where <sep> is one of the characters in
+`bog-citekey-file-name-separators'.")
(defcustom bog-file-renaming-func 'bog-file-ask-on-conflict
"Function used to rename staged files.
@@ -314,7 +315,7 @@ text under point if it matches `bog-citekey-format' or using
;;;###autoload
(defun bog-rename-staged-file-to-citekey ()
- "Rename file in `bog-stage-directory' to `bog-file-directory'/<citekey>.<ext>.
+ "Rename citekey file in `bog-stage-directory' with `bog-file-renaming-func'.
The citekey will be taken from the text under point if it matches
`bog-citekey-format' or using `bog-citekey-func'."
(interactive)
@@ -342,7 +343,7 @@ The citekey will be taken from the text under point if it matches
(funcall bog-file-renaming-func staged-file citekey))))
(defun bog-file-ask-on-conflict (staged-file citekey)
- "Prompt for a new name of file for CITEKEY already exists.
+ "Rename citekey file, prompting for a new name if it already exists.
STAGED-FILE will be renamed to <citekey>.<ext> within
`bog-file-directory'. If this file already exists, the user will
be prompted for another name. `bog-file-secondary-name' can be