diff options
author | Joost Kremers <joostkremers@fastmail.fm> | 2017-03-11 23:29:44 +0100 |
---|---|---|
committer | Joost Kremers <joostkremers@fastmail.fm> | 2017-03-11 23:29:44 +0100 |
commit | a0ca8b1e362dfae50b70b94e62f26670404ab1e2 (patch) | |
tree | 1c75bc5747861c48e41a47318a32cdb62bd3576c | |
parent | f3ad99e47edde956b72dd5cc88548e123e289705 (diff) |
Update doc string of `parsebib--parse-value'.
-rw-r--r-- | parsebib.el | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/parsebib.el b/parsebib.el index 729b9e2..214a14e 100644 --- a/parsebib.el +++ b/parsebib.el @@ -144,8 +144,15 @@ if a matching delimiter was found." (defun parsebib--parse-value (limit &optional strings) "Parse value at point. -Do not parse beyond LIMIT. Replace @string abbrevs with STRINGS -if non-nil." +A value is either a field value or a @String expansion. Return +the value as a string. No parsing is done beyond LIMIT, but note +that parsing may stop well before LIMIT. + +STRINGS, if non-nil, is a hash table of @String definitions. +@String abbrevs in the value to be parsed are then replaced with +their expansions. Additionally, newlines in field values are +removed, white space is reduced to a single space and braces or +double quotes around field values are removed." (let (res) (while (and (< (point) limit) (not (looking-at-p ","))) |