summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoost Kremers <joostkremers@fastmail.fm>2017-03-27 08:32:41 +0200
committerJoost Kremers <joostkremers@fastmail.fm>2017-03-27 08:41:11 +0200
commit7e69eb7400cfe65584ed8c8c2954f73f7941aa2e (patch)
tree7a44c6add2c49cac024f1c09dcadc12a650c7025
parentf71e4c46ee8f2caa1c6f142a95ef495affdb2fc2 (diff)
Update docstring of parsebib-read-comment
-rw-r--r--parsebib.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/parsebib.el b/parsebib.el
index 74901a3..c1b7226 100644
--- a/parsebib.el
+++ b/parsebib.el
@@ -392,8 +392,12 @@ POS can be a number or a marker and defaults to point."
(defun parsebib-read-comment (&optional pos)
"Read the @Comment beginning at the line POS is on.
-Return value is the text of the @Comment or nil if no comment is
-found.
+Return value is the text of the @Comment including the braces.
+For comments that last until the end of the line (i.e., comments
+that are not delimited by braces), the return value includes the
+whitespace between `@comment' and the actual comment text.
+
+If no comment could be found, return nil.
POS can be a number or a marker. It does not have to be at the
beginning of a line, but the @Comment entry must start at the