GNU bug report logs - #69402
28.3; checkdoc does not check for docstrings wider than 80 characters

Previous Next

To reply to this bug, email your comments to 69402 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tim Landscheidt <tim <at> tim-landscheidt.de>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.3; checkdoc does not check for docstrings wider than 80 characters
Date: Mon, 26 Feb 2024 08:12:17 +0000

(I am not sure whether this is a bug or a missing feature;
the reference to byte-compile-docstring-max-column in
lisp/emacs-lisp/checkdoc.el made me assume this should
work.)

With Emacs 28.3 and a test-checkdoc.el:

| ;;; test-checkdoc.el --- Tests

| ;;; Commentary:
| ;;

| ;;; Code:

| (defcustom my-test-configuration
|   nil
|   "This docstring is longer than xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx characters."
|   :group 'does-not-matter
|   :type 'string)

| (defvar my-test-variable
|   nil
|   "This docstring is longer than xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx characters.")

| (defun my-test-function
|   nil
|   "This docstring is longer than xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx characters.")

| (provide 'test-checkdoc)

| ;;; test-checkdoc.el ends here

M-x checkdoc RET reports:

| Buffer comments and tags:  Ok
| Documentation style:       Ok
| Message/Query text style:  Ok
| Unwanted Spaces:           Ok

However, byte-compile-file complains:

| ^L
| Compiling file /tmp/test-checkdoc.el at Mon Feb 26 08:10:04 2024
| test-checkdoc.el:8:1: Warning: custom-declare-variable `my-test-configuration'
|     docstring wider than 80 characters
| test-checkdoc.el:14:1: Warning: defvar `my-test-variable' docstring wider than
|     80 characters

| In my-test-function:
| test-checkdoc.el:18:8: Warning: docstring wider than 80 characters

IMHO, checkdoc should check that docstrings are no longer
than 80 (or byte-compile-docstring-max-column) characters.

Message #8 received at 69402 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Tim Landscheidt <tim <at> tim-landscheidt.de>
Cc: 69402 <at> debbugs.gnu.org
Subject: Re: bug#69402: 28.3;
 checkdoc does not check for docstrings wider than 80 characters
Date: Mon, 26 Feb 2024 14:53:46 +0200

> From: Tim Landscheidt <tim <at> tim-landscheidt.de>
> Date: Mon, 26 Feb 2024 08:12:17 +0000
> 
> IMHO, checkdoc should check that docstrings are no longer
> than 80 (or byte-compile-docstring-max-column) characters.

It does.  Add one more long line to the doc string, and you will see
it.

Previous Next

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