unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Basil L. Contovounesios" <basil@contovou.net>
To: "Mattias Engdegård" <mattias.engdegard@gmail.com>
Cc: Eli Zaretskii <eliz@gnu.org>,  emacs-devel <emacs-devel@gnu.org>
Subject: Re: Control characters in doc strings
Date: Wed, 28 Feb 2024 16:10:53 +0100	[thread overview]
Message-ID: <87jzmotyiq.fsf@epfl.ch> (raw)
In-Reply-To: <112E1220-B100-40A0-969C-079570637ABE@gmail.com> ("Mattias Engdegård"'s message of "Sat, 24 Feb 2024 12:14:50 +0100")

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)

It looks like verilog-mode intentionally uses form feed characters to
section large docstrings.  Perhaps these are used as a source for
generating external (e.g. HTML) docs (if not of verilog-mode then
conceivably of other packages).  Perhaps we should continue to allow
such usage?  (These are the only in-tree instances, BTW.)

Thanks,
-- 
Basil



  reply	other threads:[~2024-02-28 15:10 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 [this message]
2024-02-28 15:33     ` Alfred M. Szmidt
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=87jzmotyiq.fsf@epfl.ch \
    --to=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).