emacs/test/lisp/emacs-lisp/bytecomp-resources/warn-wide-docstring-defun.el at 08b62132ddee01f0c84bc478b718370b51fade6a - masscollaborationlabs/emacs - Masscollabs Services: Beyond Sharing , Liberating The Software World

masscollaborationlabs/emacs

mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-09 13:40:50 +00:00

Mattias Engdegård 61b2f5f96b Single string literal in body is return value only, not doc string

A function or macro body consisting of a single string literal now only
uses it as a return value.  Previously, it had the dual uses as return
value and doc string, which was never what the programmer wanted and
had some inconvenient consequences (bug#69387).

This change applies to `lambda`, `defun`, `defsubst` and `defmacro`
forms; most other defining forms already worked in the sensible way.

* lisp/emacs-lisp/bytecomp.el (byte-compile-lambda):
Don't use a lone string literal as doc string.
* test/lisp/emacs-lisp/bytecomp-resources/warn-wide-docstring-defun.el
(foo): Update docstring warning test.
* doc/lispref/functions.texi (Function Documentation): Update.
* etc/NEWS: Announce.

2024-03-07 13:47:53 +01:00

4 lines

157 B

EmacsLisp

Raw Blame History

 ;;; -*- lexical-binding: t -*-
 (defun foo ()
   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
   nil)