unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#52018: 28.0.60; Improve documentation for compilation-finish-functions
@ 2021-11-21 10:48 Thibault Polge
  2021-11-21 15:13 ` Eli Zaretskii
  0 siblings, 1 reply; 17+ messages in thread
From: Thibault Polge @ 2021-11-21 10:48 UTC (permalink / raw)
  To: 52018

[-- Attachment #1: Type: text/plain, Size: 155 bytes --]

The attached patch links the docstring of `compilation-finish-functions`
to the info manual page documenting the string argument those functions
receive.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Clarify-documentation-of-compilation-finish-function.patch --]
[-- Type: text/x-patch, Size: 1079 bytes --]

From ff48c17796acb3d6a77c893bd2b58bff62d43b03 Mon Sep 17 00:00:00 2001
From: Thibault Polge <thibault@thb.lt>
Date: Sun, 21 Nov 2021 11:41:51 +0100
Subject: [PATCH] Clarify documentation of `compilation-finish-functions`

Link to reference on the possible values of the string argument.
---
 lisp/progmodes/compile.el | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index ac26f5e934..b71ee410bb 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -114,7 +114,10 @@ compilation-buffer-name-function
 (defvar compilation-finish-functions nil
   "Functions to call when a compilation process finishes.
 Each function is called with two arguments: the compilation buffer,
-and a string describing how the process finished.")
+and a string describing how the process finished.
+
+That string is the sentinel's event type string, see info
+node `(elisp) Sentinels' for more details.")
 
 (defvar compilation-in-progress nil
   "List of compilation processes now running.")
-- 
2.33.1


[-- Attachment #3: Type: text/plain, Size: 24 bytes --]


Best regards,
Thibault

^ permalink raw reply related	[flat|nested] 17+ messages in thread

end of thread, other threads:[~2021-11-24 16:31 UTC | newest]

Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-21 10:48 bug#52018: 28.0.60; Improve documentation for compilation-finish-functions Thibault Polge
2021-11-21 15:13 ` Eli Zaretskii
2021-11-21 19:08   ` Thibault Polge
2021-11-21 19:25     ` Eli Zaretskii
2021-11-21 19:44       ` Thibault Polge
2021-11-21 19:53         ` Eli Zaretskii
2021-11-21 20:00           ` Thibault Polge
2021-11-21 20:11             ` Eli Zaretskii
2021-11-21 20:20               ` Thibault Polge
2021-11-21 20:29                 ` Eli Zaretskii
2021-11-22  9:12                   ` Thibault Polge
2021-11-22 16:56                     ` Eli Zaretskii
2021-11-23  9:26                       ` Thibault Polge
2021-11-23 12:47                         ` Eli Zaretskii
2021-11-24  7:02                           ` Lars Ingebrigtsen
2021-11-24 12:40                             ` Eli Zaretskii
2021-11-24 16:31                               ` Lars Ingebrigtsen

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).