unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Alfred M. Szmidt" <ams@gnu.org>
To: "Basil L. Contovounesios" <basil@contovou.net>
Cc: mattias.engdegard@gmail.com, eliz@gnu.org, emacs-devel@gnu.org
Subject: Re: Control characters in doc strings
Date: Wed, 28 Feb 2024 10:33:17 -0500	[thread overview]
Message-ID: <E1rfLvp-0007f7-Iy@fencepost.gnu.org> (raw)
In-Reply-To: <87jzmotyiq.fsf@epfl.ch> (basil@contovou.net)

   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!

\f
;;; 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].

[...]
\f
Where the list of inputs and outputs came from the inst module.
\f
For more information see the \\[verilog-faq] and forums at URL
`https://www.veripool.org'."
  (save-excursion
[...]))



  reply	other threads:[~2024-02-28 15:33 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-24 10:58 Control characters in doc strings Eli Zaretskii
2024-02-24 11:14 ` Mattias Engdegård
2024-02-28 15:10   ` Basil L. Contovounesios
2024-02-28 15:33     ` Alfred M. Szmidt [this message]
2024-02-24 11:19 ` Emanuel Berg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E1rfLvp-0007f7-Iy@fencepost.gnu.org \
    --to=ams@gnu.org \
    --cc=basil@contovou.net \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=mattias.engdegard@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).