summaryrefslogtreecommitdiff
path: root/doc/lispref
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2010-11-20 14:52:20 -0500
committerChong Yidong <cyd@stupidchicken.com>2010-11-20 14:52:20 -0500
commitec8a6295a0e4554f2ce8164ff3fe5e2910810d0d (patch)
tree59d16ae6eef3b8a7cdb3e7df405c83961c09373c /doc/lispref
parent8d7f026f625a02854b3214f7a54e778121d266bc (diff)
downloademacs-ec8a6295a0e4554f2ce8164ff3fe5e2910810d0d.tar.gz
Document some Emacs 23.3 changes in manuals.
* doc/emacs/macos.texi (Mac / GNUstep Basics): Document ns-right-alternate-modifier. * doc/lispref/numbers.texi (Float Basics): Document float-e and float-pi. * doc/lispref/symbols.texi (Creating Symbols): Using unintern without an obarray arg is now obsolete. * doc/lispref/text.texi (Kill Functions, Kill Functions) (Low-Level Kill Ring, Low-Level Kill Ring): Remove obsolete YANK-HANDLER args. * doc/lispref/variables.texi (Defining Variables): Change "pi" example to "float-pi".
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog14
-rw-r--r--doc/lispref/numbers.texi8
-rw-r--r--doc/lispref/symbols.texi2
-rw-r--r--doc/lispref/text.texi25
-rw-r--r--doc/lispref/variables.texi18
5 files changed, 37 insertions, 30 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 79d6f71c1b4..2ea15fe3ca8 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,17 @@
+2010-11-20 Chong Yidong <cyd@stupidchicken.com>
+
+ * text.texi (Kill Functions, Kill Functions)
+ (Low-Level Kill Ring, Low-Level Kill Ring): Remove obsolete
+ YANK-HANDLER args.
+
+ * symbols.texi (Creating Symbols): Using unintern without an
+ obarray arg is now obsolete.
+
+ * numbers.texi (Float Basics): Document float-e and float-pi.
+
+ * variables.texi (Defining Variables): Change "pi" example to
+ "float-pi".
+
2010-11-12 Eli Zaretskii <eliz@gnu.org>
* customize.texi (Composite Types): Lower-case index entry.
diff --git a/doc/lispref/numbers.texi b/doc/lispref/numbers.texi
index 62b4796350e..e83da348e05 100644
--- a/doc/lispref/numbers.texi
+++ b/doc/lispref/numbers.texi
@@ -224,6 +224,14 @@ down to an integer.
@end example
@end defun
+@defvar float-e
+The mathematical constant @math{e} (2.71828@dots{}).
+@end defvar
+
+@defvar float-pi
+The mathematical constant @math{pi} (3.14159@dots{}).
+@end defvar
+
@node Predicates on Numbers
@section Type Predicates for Numbers
@cindex predicates for numbers
diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi
index 5bb44ff9675..ccf90e33cd0 100644
--- a/doc/lispref/symbols.texi
+++ b/doc/lispref/symbols.texi
@@ -383,7 +383,7 @@ See @code{documentation} in @ref{Accessing Documentation}, for another
example using @code{mapatoms}.
@end defun
-@defun unintern symbol &optional obarray
+@defun unintern symbol obarray
This function deletes @var{symbol} from the obarray @var{obarray}. If
@code{symbol} is not actually in the obarray, @code{unintern} does
nothing. If @var{obarray} is @code{nil}, the current obarray is used.
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 2510607475b..025bf1b6f85 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -865,7 +865,7 @@ adds it to the most recent element. It determines automatically (using
@code{last-command}) whether the previous command was a kill command,
and if so appends the killed text to the most recent entry.
-@deffn Command kill-region start end &optional yank-handler
+@deffn Command kill-region start end
This function kills the text in the region defined by @var{start} and
@var{end}. The text is deleted but saved in the kill ring, along with
its text properties. The value is always @code{nil}.
@@ -873,17 +873,10 @@ its text properties. The value is always @code{nil}.
In an interactive call, @var{start} and @var{end} are point and
the mark.
-@c Emacs 19 feature
If the buffer or text is read-only, @code{kill-region} modifies the kill
ring just the same, then signals an error without modifying the buffer.
This is convenient because it lets the user use a series of kill
commands to copy text from a read-only buffer into the kill ring.
-
-If @var{yank-handler} is non-@code{nil}, this puts that value onto
-the string of killed text, as a @code{yank-handler} text property.
-@xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, any
-@code{yank-handler} properties present on the killed text are copied
-onto the kill ring, like other text properties.
@end deffn
@defopt kill-read-only-ok
@@ -1068,7 +1061,7 @@ it returns the entry pointed at by the yanking pointer and does not
move the yanking pointer.
@end defun
-@defun kill-new string &optional replace yank-handler
+@defun kill-new string &optional replace
This function pushes the text @var{string} onto the kill ring and
makes the yanking pointer point to it. It discards the oldest entry
if appropriate. It also invokes the value of
@@ -1077,25 +1070,15 @@ if appropriate. It also invokes the value of
If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the
first element of the kill ring with @var{string}, rather than pushing
@var{string} onto the kill ring.
-
-If @var{yank-handler} is non-@code{nil}, this puts that value onto
-the string of killed text, as a @code{yank-handler} property.
-@xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, then
-@code{kill-new} copies any @code{yank-handler} properties present on
-@var{string} onto the kill ring, as it does with other text properties.
@end defun
-@defun kill-append string before-p &optional yank-handler
+@defun kill-append string before-p
This function appends the text @var{string} to the first entry in the
kill ring and makes the yanking pointer point to the combined entry.
Normally @var{string} goes at the end of the entry, but if
@var{before-p} is non-@code{nil}, it goes at the beginning. This
function also invokes the value of @code{interprogram-cut-function}
-(see below). This handles @var{yank-handler} just like
-@code{kill-new}, except that if @var{yank-handler} is different from
-the @code{yank-handler} property of the first entry of the kill ring,
-@code{kill-append} pushes the concatenated string onto the kill ring,
-instead of replacing the original first entry with it.
+(see below).
@end defun
@defvar interprogram-paste-function
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index a3a550868f5..20fe4dbc9fa 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -544,21 +544,23 @@ not the buffer-local value. (But you should not be making
buffer-local bindings for a symbol that is defined with
@code{defconst}.)
-Here, @code{pi} is a constant that presumably ought not to be changed
-by anyone (attempts by the Indiana State Legislature notwithstanding).
-As the second form illustrates, however, this is only advisory.
+An example of the use of @code{defconst} is Emacs' definition of
+@code{float-pi}---the mathematical constant @math{pi}, which ought not
+to be changed by anyone (attempts by the Indiana State Legislature
+notwithstanding). As the second form illustrates, however,
+@code{defconst} is only advisory.
@example
@group
-(defconst pi 3.1415 "Pi to five places.")
- @result{} pi
+(defconst float-pi 3.141592653589793 "The value of Pi.")
+ @result{} float-pi
@end group
@group
-(setq pi 3)
- @result{} pi
+(setq float-pi 3)
+ @result{} float-pi
@end group
@group
-pi
+float-pi
@result{} 3
@end group
@end example