From 4c2d1ef2ca3e0f0a820193fbb8248833f147c031 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sat, 26 Apr 2014 17:13:15 -0400 Subject: Clarify some docstrings --- bog.el | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'bog.el') 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 , it will find -files with the format *., where is one -of the characters in `bog-citekey-file-name-separators'.") +files with the format .* and *., +where 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'/.. + "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 . within `bog-file-directory'. If this file already exists, the user will be prompted for another name. `bog-file-secondary-name' can be -- cgit v1.2.3