unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Colin Woodbury" <colin@fosskers.ca>
To: emacs-devel@gnu.org
Subject: [PATCH] docs: remove spurious @example wrapping
Date: Sun, 30 May 2021 18:25:16 -0700	[thread overview]
Message-ID: <fc0492a7-df00-477d-a02b-071121717d7e@www.fastmail.com> (raw)


[-- Attachment #1.1: Type: text/plain, Size: 244 bytes --]

This patch removes a spurious layer of @example wrapping, which looks a little strange in the rendered documentation. See the bottom of https://www.gnu.org/software/emacs/manual/html_node/elisp/Defining-Macros.html for the issue.

Cheers,
Colin

[-- Attachment #1.2: Type: text/html, Size: 530 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: spurious-example-attr.patch --]
[-- Type: text/x-patch; name="spurious-example-attr.patch", Size: 642 bytes --]

diff --git a/doc/lispref/macros.texi b/doc/lispref/macros.texi
index b8df363614..cf23ecb9d4 100644
--- a/doc/lispref/macros.texi
+++ b/doc/lispref/macros.texi
@@ -240,7 +240,6 @@ they cannot be called interactively.
 of constants and nonconstant parts.  To make this easier, use the
 @samp{`} syntax (@pxref{Backquote}).  For example:
 
-@example
 @example
 @group
 (defmacro t-becomes-nil (variable)
@@ -253,7 +252,6 @@ of constants and nonconstant parts.  To make this easier, use the
      @equiv{} (if (eq foo t) (setq foo nil))
 @end group
 @end example
-@end example
 
 @node Problems with Macros
 @section Common Problems Using Macros

             reply	other threads:[~2021-05-31  1:25 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-31  1:25 Colin Woodbury [this message]
2021-05-31  8:55 ` [PATCH] docs: remove spurious @example wrapping Lars Ingebrigtsen

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=fc0492a7-df00-477d-a02b-071121717d7e@www.fastmail.com \
    --to=colin@fosskers.ca \
    --cc=emacs-devel@gnu.org \
    /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).