From debbugs-submit-bounces@debbugs.gnu.org Mon Feb 26 03:12:54 2024 Received: (at submit) by debbugs.gnu.org; 26 Feb 2024 08:12:54 +0000 Received: from localhost ([127.0.0.1]:43289 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1reW6Y-0003JM-3u for submit@debbugs.gnu.org; Mon, 26 Feb 2024 03:12:54 -0500 Received: from lists.gnu.org ([209.51.188.17]:36250) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1reW6V-0003JB-WE for submit@debbugs.gnu.org; Mon, 26 Feb 2024 03:12:52 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1reW66-0002t0-AR for bug-gnu-emacs@gnu.org; Mon, 26 Feb 2024 03:12:26 -0500 Received: from gavdos.tim-landscheidt.de ([2a01:4f8:1c0c:4bd6::1]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1reW63-0002zX-2u for bug-gnu-emacs@gnu.org; Mon, 26 Feb 2024 03:12:26 -0500 Received: from port-62-145-29-194.static.as20676.net ([62.145.29.194]:44440 helo=vagabond) by gavdos.tim-landscheidt.de with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1reW5y-00Dzl3-1I for bug-gnu-emacs@gnu.org; Mon, 26 Feb 2024 08:12:18 +0000 From: Tim Landscheidt To: bug-gnu-emacs@gnu.org Subject: 28.3; checkdoc does not check for docstrings wider than 80 characters Organization: https://www.tim-landscheidt.de/ Date: Mon, 26 Feb 2024 08:12:17 +0000 Message-ID: <877cirod9a.fsf@vagabond.tim-landscheidt.de> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=2a01:4f8:1c0c:4bd6::1; envelope-from=tim@tim-landscheidt.de; helo=gavdos.tim-landscheidt.de X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.4 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.4 (--) (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. From debbugs-submit-bounces@debbugs.gnu.org Mon Feb 26 07:54:24 2024 Received: (at 69402) by debbugs.gnu.org; 26 Feb 2024 12:54:24 +0000 Received: from localhost ([127.0.0.1]:33833 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1reaUy-0002bc-Az for submit@debbugs.gnu.org; Mon, 26 Feb 2024 07:54:24 -0500 Received: from eggs.gnu.org ([209.51.188.92]:60632) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1reaUw-0002bA-1b for 69402@debbugs.gnu.org; Mon, 26 Feb 2024 07:54:22 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1reaUQ-0003ZK-3Q; Mon, 26 Feb 2024 07:53:50 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=BJnftI51EqX5T3ItFhXAXoG84giBy0eHdWBQE4r8FNg=; b=L5iGKRxGvS0v vKAgTuyQV3g7g8JAZaINGQB0fU2qbB+r5e0OBfte+KldKDwdhr/SEI/S9MeYS3OpT4m38xgxs7pm3 AtENgysmhvqQGLnikF4lrWQHKFiNch4L84jUY72YfOixImlXj6chEf/aXM4XsWXnBsB3ZDJgoy0DM yerOQabhHM4ogLRVkRaZAq4OXwhH70BAA5TwsujZR+rRaiKVb3d4Wa41MhNHymZBev5wj49rouZTS bATo6ytok2f3nl+FP1UkXyI1hzov1n6NVoLCSyQUow+YDpKGC/hZA6uVvkQI92tWDVslxLz2dUdF+ 9k3jxJtXEwzdvi++IX4a8Q==; Date: Mon, 26 Feb 2024 14:53:46 +0200 Message-Id: <865xybwfmt.fsf@gnu.org> From: Eli Zaretskii To: Tim Landscheidt In-Reply-To: <877cirod9a.fsf@vagabond.tim-landscheidt.de> (message from Tim Landscheidt on Mon, 26 Feb 2024 08:12:17 +0000) Subject: Re: bug#69402: 28.3; checkdoc does not check for docstrings wider than 80 characters References: <877cirod9a.fsf@vagabond.tim-landscheidt.de> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 69402 Cc: 69402@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Tim Landscheidt > 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. From debbugs-submit-bounces@debbugs.gnu.org Wed Jan 08 01:44:12 2025 Received: (at 69402) by debbugs.gnu.org; 8 Jan 2025 06:44:13 +0000 Received: from localhost ([127.0.0.1]:45768 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tVPnY-0000vt-K2 for submit@debbugs.gnu.org; Wed, 08 Jan 2025 01:44:12 -0500 Received: from mail-ed1-x532.google.com ([2a00:1450:4864:20::532]:42248) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1tVPnV-0000vU-Nz for 69402@debbugs.gnu.org; Wed, 08 Jan 2025 01:44:10 -0500 Received: by mail-ed1-x532.google.com with SMTP id 4fb4d7f45d1cf-5d3dce16a3dso997082a12.1 for <69402@debbugs.gnu.org>; Tue, 07 Jan 2025 22:44:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736318643; x=1736923443; darn=debbugs.gnu.org; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:from:to:cc:subject:date:message-id:reply-to; bh=SQiNwYcvXwKXx7XbgpuwD+/LF59MdamkUXQJ6S6SK2o=; b=V9EJPYwq35Fom8VczZy/GaP8VgznOXLihVV3LQuorEU2kYlhEuGUgiNqJ7aJK23f4D OkLxWG0Dv6xdFa9PsPKAAQanOl4jNihRPxCM/CKgN0S6na6g2JAgjbAmqcv1BHMisRTv 8WXKd1WhhPJcWfeqkrFV+bhs4wpkzKxeA/ISZkihXh7I46XB2nyN1oyj5qBOOJYue/qR OtL8ONmqb2azOVsWqhgThdNjbXLgUB4abNIP7Wip9IFQQIY/ysr8YXirq3DQGkWhFZgm pP0LCgjwMOUMGJDucVfwLZnDo9iEPNQCTrBoRykE6vdYK3o6Bj3wbh4O3L6gJAXUtmB6 1jLw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736318643; x=1736923443; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=SQiNwYcvXwKXx7XbgpuwD+/LF59MdamkUXQJ6S6SK2o=; b=kKAKRrmP59MEdiv4hqY1SH6SSd5NZ7qqREU4ZA1aPZIyU6e1iVOXK1XLhw3A2f89g4 Dvfh/JpcCKf+5l2IB4TkmsGfzk61U8/Gg1a5NYiPahoEt2eNerUNxpyOXiAEqdt3dbTf /oW6tdq9WLthOedC2QMLorDmc4ThcXGKMXHW5jwR8qEYd5Cg7KtFV4LumTgvDQ5hvTgF 3w7cGJnU1li/S4SKZ4cEOxJgqct6JyP1O8RS/PzHceZQBhZOMdER0VfONeLpgR+9sVLT yWSGs2v6YeRmxmupFuNdmZRmRy9Aj9lnIWmAoG7Erp+cff51yXDQ1yrBpXXve3HNjPGI 3oqQ== X-Gm-Message-State: AOJu0YyQJrM6mHMY0CAdSgOcISUOeOwxRZmtGpcm9fZ3kkTRHUwMTRiG lsh6JJNEdzyQbo1BG2LYfZtvvrHEExADycwNPhkflI4ZnZGkk3akAqvjJ8pacWzVXvhZ0ynAOVz Ok7aKBhccIEJUejaqV4g6qs2355M3nw== X-Gm-Gg: ASbGncs1kXa2fFDGQJoS+ZCyplwI4GrrQS+7CcfzdZ/s/T/qvn8StBBZRcF5H27XZ7k bixVWqtiHG3hENy/2jsCVEYV/6F0hjGJBlZBY5Crr X-Google-Smtp-Source: AGHT+IGyU7HlfZjHch0r7OcZptXVR4kiDvejXCouS8u/tJiN5WgrrcHy9JKsusD5+a7N8ITdwEdP7VzOV7piMmMoVLY= X-Received: by 2002:a05:6402:26cd:b0:5d0:d845:2882 with SMTP id 4fb4d7f45d1cf-5d971ba439cmr1415300a12.13.1736318643268; Tue, 07 Jan 2025 22:44:03 -0800 (PST) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Wed, 8 Jan 2025 00:44:02 -0600 From: Stefan Kangas In-Reply-To: <865xybwfmt.fsf@gnu.org> References: <877cirod9a.fsf@vagabond.tim-landscheidt.de> <865xybwfmt.fsf@gnu.org> MIME-Version: 1.0 Date: Wed, 8 Jan 2025 00:44:02 -0600 X-Gm-Features: AbW1kvYy406IPaaNGZiws8kAsHJQDETCHfKXL23G6UiduUyfZo4dTEYOgaQxGIQ Message-ID: Subject: Re: bug#69402: 28.3; checkdoc does not check for docstrings wider than 80 characters To: Eli Zaretskii , Tim Landscheidt Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 69402 Cc: 69402@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) severity 69402 wishlist tags 69402 wontfix close 69402 thanks Eli Zaretskii writes: >> From: Tim Landscheidt >> 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. I think we would take a patch to fix this minor inconsistency, but it's not something that we will invest any time in fixing. I'm therefore closing this bug report now. Sorry. From unknown Sun Jun 22 07:46:54 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 05 Feb 2025 12:24:06 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator