From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "Alfred M. Szmidt" Newsgroups: gmane.emacs.devel Subject: Re: Control characters in doc strings Date: Wed, 28 Feb 2024 10:33:17 -0500 Message-ID: References: <867ciuyvqq.fsf@gnu.org> <112E1220-B100-40A0-969C-079570637ABE@gmail.com> <87jzmotyiq.fsf@epfl.ch> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16641"; mail-complaints-to="usenet@ciao.gmane.io" Cc: mattias.engdegard@gmail.com, eliz@gnu.org, emacs-devel@gnu.org To: "Basil L. Contovounesios" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Feb 28 16:35:19 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rfLxn-00040l-Cg for ged-emacs-devel@m.gmane-mx.org; Wed, 28 Feb 2024 16:35:19 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rfLvv-0000Sa-Er; Wed, 28 Feb 2024 10:33:23 -0500 Original-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 1rfLvt-0000S2-76 for emacs-devel@gnu.org; Wed, 28 Feb 2024 10:33:21 -0500 Original-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 1rfLvp-0002FI-Sr; Wed, 28 Feb 2024 10:33:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=Date:References:Subject:In-Reply-To:To:From: mime-version; bh=7TVCuJh/pduVvEQhSHNGGfWe7vEFFCg59xQrZDGrhWA=; b=GB0dWMmcxLQ9 xx1YywprWoeTI6zTZehIf8+dVoJa/O63FDNzQAeBOdunxvWUPoSs7lYcU+DZqabZoE2jQZhqFe3vv jt7C9RWE9XBmZtqmk2R0+MAJ4KxvjnayLXwaCpdchp5xt1w3q8LMbqgfRWblS1rGaiTh3e+XXgOjQ 9RP9iEc1qObqRauQpXalScUaXVCHwa7L3gMiiTeJz5DBzzEQXNZQfHiDj5nXkTIRZi35Z5ZSeh+uX 6nkHZJzk9CHSAJnQgaIsedDcZIatCNus4t1Y15l8+OQWduOSs69Zj6dk6qaEsjOikgsnWtVbhJ8r3 cHwfM0PGvSWj6r0+mUd4fw==; Original-Received: from ams by fencepost.gnu.org with local (Exim 4.90_1) (envelope-from ) id 1rfLvp-0007f7-Iy; Wed, 28 Feb 2024 10:33:17 -0500 In-Reply-To: <87jzmotyiq.fsf@epfl.ch> (basil@contovou.net) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:316621 Archived-At: What about these? progmodes/verilog-mode.el:12424:2: Warning: docstring contains control char #x0c (position 2845) progmodes/verilog-mode.el:12875:2: Warning: docstring contains control char #x0c (position 1187) I'd think it is fair to consider this specific usage "just wrong; don't do it" -- if you narrow to a page you will get something that is not correct and will screw Lisp indentation and all kind of things! ;;; Auto creation: ;; (defun verilog-auto-arg-ports (sigs message indent-pt) "Print a list of ports for AUTOARG. Takes SIGS list, adds MESSAGE to front and inserts each at INDENT-PT." [...]) (defun verilog-auto-arg () "Expand AUTOARG statements. Replace the argument declarations at the beginning of the module with ones automatically derived from input and output statements. This can be dangerous if the module is instantiated using position-based connections, so use only name-based when instantiating the resulting module. Long lines are split based on the `fill-column', see \\[set-fill-column]. [...] Where the list of inputs and outputs came from the inst module. For more information see the \\[verilog-faq] and forums at URL `https://www.veripool.org'." (save-excursion [...]))