GNU bug report logs - #50041
Add font-lock-doc-markup-face

Previous Next

Package: emacs;

Reported by: Mattias Engdegård <mattiase <at> acm.org>

Date: Fri, 13 Aug 2021 10:54:01 UTC

Severity: normal

Done: Mattias Engdegård <mattiase <at> acm.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Mattias Engdegård <mattiase <at> acm.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: larsi <at> gnus.org, 50041 <at> debbugs.gnu.org
Subject: bug#50041: Add font-lock-doc-markup-face
Date: Fri, 13 Aug 2021 23:24:13 +0200
[Message part 1 (text/plain, inline)]
13 aug. 2021 kl. 20.31 skrev Eli Zaretskii <eliz <at> gnu.org>:

> If the doc string of font-lock-doc-face would explain its usage,
> having a link to it might be sufficient.  But doc string of
> font-lock-doc-face is just this:
> 
>  "Font Lock mode face used to highlight documentation."

All faces have very terse doc strings and I naturally assumed that was the preferred style; it certainly didn't prevent me from understanding it. Anyway, I have amended the doc strings of both font-lock-doc-face and font-lock-doc-markup-face.

> Also, I think "for mark-up elements" is too terse and assumes too much
> of prior knowledge; we should make more clear what that means, or
> provide a couple of examples.

Maybe, but let's not exaggerate; this is standard terminology. Nevertheless, the text has been extended.

> The NEWS entry is now clear enough, but I think the manual
> and the doc string still need some work.

Very well, they have now all been expanded further.

[0001-Add-font-lock-doc-markup-face-bug-50041.patch (application/octet-stream, attachment)]

This bug report was last modified 3 years and 338 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.