From 7e69eb7400cfe65584ed8c8c2954f73f7941aa2e Mon Sep 17 00:00:00 2001 From: Joost Kremers Date: Mon, 27 Mar 2017 08:32:41 +0200 Subject: Update docstring of parsebib-read-comment --- parsebib.el | 8 ++++++-- 1 file 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 -- cgit v1.2.3