[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 95b2ab3 18/19: Fix some documentation formatting ni
From: |
Gemini Lasswell |
Subject: |
[Emacs-diffs] master 95b2ab3 18/19: Fix some documentation formatting nits |
Date: |
Fri, 3 Aug 2018 13:33:00 -0400 (EDT) |
branch: master
commit 95b2ab3dccdc756614b4c8f45a7b206d61753705
Author: Gemini Lasswell <address@hidden>
Commit: Gemini Lasswell <address@hidden>
Fix some documentation formatting nits
* doc/misc/ert.texi (Running Tests Interactively): Correct
Elisp manual titile in xref.
* doc/lispref/edebug.texi (Edebug Misc): Use single argument
form of xref.
* doc/lispref/debugging.texi (Backtraces): Add comma and
period after xref braces.
(Backtraces): Correct Emacs manual title.
(Internals of Debugger): Add a space before period.
---
doc/lispref/debugging.texi | 10 +++++-----
doc/lispref/edebug.texi | 2 +-
doc/misc/ert.texi | 2 +-
etc/NEWS | 12 ++++++------
4 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 841b16e..9b3ba6c 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -402,8 +402,8 @@ assumptions are false if the debugger is running
interpreted.
@cindex backtrace buffer
Debugger mode is derived from Backtrace mode, which is also used to
-show backtraces by Edebug and ERT. (@pxref{Edebug} and @ref{Top,the
-ERT manual,, ert, ERT: Emacs Lisp Regression Testing})
+show backtraces by Edebug and ERT. (@pxref{Edebug}, and @ref{Top,the
+ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.)
@cindex stack frame
The backtrace buffer shows you the functions that are executing and
@@ -423,9 +423,9 @@ source code is located. You can click with the mouse on
that name, or
move to it and type @key{RET}, to visit the source code. You can also
type @key{RET} while point is on any name of a function or variable
which is not underlined, to see help information for that symbol in a
-help buffer, if any exists. The @code{xref-find-definitions} command,
+help buffer, if any exists. The @code{xref-find-definitions} command,
bound to @key{M-.}, can also be used on any identifier in a backtrace
-(@pxref{Looking Up Identifiers,,,emacs,Emacs manual}).
+(@pxref{Looking Up Identifiers,,,emacs, The GNU Emacs Manual}).
In backtraces, the tails of long lists and the ends of long strings,
vectors or structures, as well as objects which are deeply nested,
@@ -690,7 +690,7 @@ Each line of the backtrace represents one function call.
The line
shows the function followed by a list of the values of the function's
arguments if they are all known; if they are still being computed, the
line consists of a list containing the function and its unevaluated
-arguments. Long lists or deeply nested structures may be elided.
+arguments. Long lists or deeply nested structures may be elided.
@smallexample
@group
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi
index 59c9a68..54200b9 100644
--- a/doc/lispref/edebug.texi
+++ b/doc/lispref/edebug.texi
@@ -442,7 +442,7 @@ Redisplay the most recently known expression result in the
echo area
Display a backtrace, excluding Edebug's own functions for clarity
(@code{edebug-backtrace}).
address@hidden,, Backtraces, elisp}, for a description of backtraces
address@hidden, for a description of backtraces
and the commands which work on them.
If you would like to see Edebug's functions in the backtrace,
diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index e2aeeb1..6a34f5c 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -276,7 +276,7 @@ Pressing @kbd{r} re-runs the test near point on its own.
Pressing
definition of the test near point (@address@hidden has the same effect
if point is on the name of the test). On a failed test, @kbd{b} shows
the backtrace of the failure. @xref{Debugging,, Backtraces, elisp,
-the Emacs Lisp Reference Manual}, for more information about
+GNU Emacs Lisp Reference Manual}, for more information about
backtraces.
@kindex address@hidden, in ert results buffer}
diff --git a/etc/NEWS b/etc/NEWS
index 53b7765..9c78bd5 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -471,7 +471,7 @@ and case-sensitivity together with search strings in the
search ring.
+++
*** The Lisp Debugger is now based on 'backtrace-mode'.
Backtrace mode adds fontification and commands for changing the
-appearance of backtrace frames. See the node "Backtraces" in the Elisp
+appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
** Edebug
@@ -484,9 +484,9 @@ using the new variables 'edebug-behavior-alist',
globally or for individual definitions.
+++
-*** Edebug's backtrace buffer now uses 'backtrace-mode'. Backtrace
-mode adds fontification, links and commands for changing the
-appearance of backtrace frames. See the node "Backtraces" in the Elisp
+*** Edebug's backtrace buffer now uses 'backtrace-mode'.
+Backtrace mode adds fontification, links and commands for changing the
+appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
The binding of 'd' in Edebug's keymap is now 'edebug-pop-to-backtrace'
@@ -523,7 +523,7 @@ less verbose by removing non-essential information.
+++
*** ERT's backtrace buffer now uses 'backtrace-mode'.
Backtrace mode adds fontification and commands for changing the
-appearance of backtrace frames. See the node "Backtraces" in the Elisp
+appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
** Gamegrid
@@ -702,7 +702,7 @@ used by the Language Server Protocol (LSP), is readily
available.
** Backtrace mode improves viewing of Elisp backtraces.
Backtrace mode adds pretty printing, fontification and ellipsis
expansion to backtrace buffers produced by the Lisp debugger, Edebug
-and ERT. See the node "Backtraces" in the Elisp manual for
+and ERT. See the node "Backtraces" in the Elisp manual for
documentation of the new mode and its commands.
- [Emacs-diffs] master updated (e65ec81 -> da0054c), Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 9aa9d79 07/19: Add links in backtraces to functions written in C (bug#25393), Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 5b50fa5 04/19: Always make buttons from function names in backtraces, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 2ede75c 10/19: Change keybinding for backtrace-collapse from '=' to '-', Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 8a76209 02/19: Add methods for strings to cl-print, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master d6b364e 05/19: Lazily print backtrace frame local variables, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master eba16e5 01/19: Support ellipsis expansion in cl-print, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master af5f377 08/19: Add link in backtraces to position in buffer being evaluated (bug#14081), Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 95b2ab3 18/19: Fix some documentation formatting nits,
Gemini Lasswell <=
- [Emacs-diffs] master 58be6cb 17/19: Fix typo in edebug-backtrace-hide-instrumentation's docstring., Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master ca98377 14/19: Add new commands to Edebug backtraces, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master bb9de87 06/19: Add prefix argument to backtrace-toggle-print-circle, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 9879151 12/19: * lisp/emacs-lisp/debug.el (debugger-mode-map): Use easy-menu-define., Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 1459ad2 13/19: Add a menu for backtrace-mode, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 3cd6a68 16/19: Give two backtrace-mode commands better names, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 83af893 15/19: Move 'backtrace' from subr.el to backtrace.el, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master 04cc0b6 09/19: Add more tests for backtrace-mode, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master a3ba34a 11/19: Add new command to expand all "..."s in a backtrace frame, Gemini Lasswell, 2018/08/03
- [Emacs-diffs] master e09120d 03/19: Add backtrace-mode and use it in the debugger, ERT and Edebug, Gemini Lasswell, 2018/08/03