unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* [PATCH] docs: remove spurious @example wrapping
@ 2021-05-31  1:25 Colin Woodbury
  2021-05-31  8:55 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 2+ messages in thread
From: Colin Woodbury @ 2021-05-31  1:25 UTC (permalink / raw)
  To: emacs-devel


[-- 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

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] docs: remove spurious @example wrapping
  2021-05-31  1:25 [PATCH] docs: remove spurious @example wrapping Colin Woodbury
@ 2021-05-31  8:55 ` Lars Ingebrigtsen
  0 siblings, 0 replies; 2+ messages in thread
From: Lars Ingebrigtsen @ 2021-05-31  8:55 UTC (permalink / raw)
  To: Colin Woodbury; +Cc: emacs-devel

"Colin Woodbury" <colin@fosskers.ca> writes:

> 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.

Thanks; applied to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-05-31  8:55 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-31  1:25 [PATCH] docs: remove spurious @example wrapping Colin Woodbury
2021-05-31  8:55 ` Lars Ingebrigtsen

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).