From f3b1b5fb5034de026adc41cf2403cff42f4a0b67 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Mon, 24 Jun 2019 00:04:04 +0200 Subject: Document syntax-ppss-context * doc/lispref/syntax.texi (Parser State): Document it. * lisp/emacs-lisp/syntax.el (syntax-ppss-context): Add a doc string (bug#32504). --- lisp/emacs-lisp/syntax.el | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'lisp/emacs-lisp/syntax.el') diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el index 60ed531e63d..6464e2a52db 100644 --- a/lisp/emacs-lisp/syntax.el +++ b/lisp/emacs-lisp/syntax.el @@ -371,6 +371,10 @@ itself at the outermost level), return nil." (nth 8 ppss))) (defsubst syntax-ppss-context (ppss) + "Say whether PPSS is a string, a comment, or something else. +If PPSS is a string, the symbol `string' is returned. If it's a +comment, the symbol `comment' is returned. If it's something +else, nil is returned." (cond ((nth 3 ppss) 'string) ((nth 4 ppss) 'comment) -- cgit v1.2.3