Doc fixes.

[bpt/emacs.git] / lisp / emacs-lisp / float.el

diff --git a/lisp/emacs-lisp/float.el b/lisp/emacs-lisp/float.el
index ce2ab10..2fad3fc 100644 (file)
--- a/lisp/emacs-lisp/float.el
+++ b/lisp/emacs-lisp/float.el
@@ -1,11 +1,16 @@
+;;; float.el --- obsolete floating point arithmetic package.
+
 ;; Copyright (C) 1986 Free Software Foundation, Inc.
-;; Author Bill Rosenblatt
+
+;; Author: Bill Rosenblatt
+;; Maintainer: FSF
+;; Keywords: extensions
 
 ;; This file is part of GNU Emacs.
 
 ;; GNU Emacs is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 1, or (at your option)
+;; the Free Software Foundation; either version 2, or (at your option)
 ;; any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
@@ -14,11 +19,12 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:
 
-;; Floating point arithmetic package.
-;;
 ;; Floating point numbers are represented by dot-pairs (mant . exp)
 ;; where mant is the 24-bit signed integral mantissa and exp is the
 ;; base 2 exponent.
@@ -46,7 +52,7 @@
 ;; June 20, 1986
 ;;
 
-(provide 'float)
+;;; Code:
 
 ;; fundamental implementation constants
 (defconst exp-base 2
@@ -66,10 +72,10 @@
   "Number of highest bit")
 
 (defconst mantissa-maxval (1- (ash 1 maxbit))
-  "Maximum permissable value of mantissa")
+  "Maximum permissible value of mantissa")
 
 (defconst mantissa-minval (ash 1 maxbit)
-  "Minimum permissable value of mantissa")
+  "Minimum permissible value of mantissa")
 
 (defconst floating-point-regexp
   "^[ \t]*\\(-?\\)\\([0-9]*\\)\
@@ -386,11 +392,10 @@ Optional second argument non-nil means use scientific notation."
 ;; digits of the exponent.
 (defun string-to-float (str)
   "Convert the string to a floating point number.
-Accepts a decimal string in scientific notation, 
-with exponent preceded by either E or e.
-Only the 6 most significant digits of the integer and fractional parts
-are used; only the first two digits of the exponent are used.
-Negative signs preceding both the decimal number and the exponent
+Accepts a decimal string in scientific notation,  with exponent preceded
+by either E or e.  Only the six most significant digits of the integer
+and fractional parts are used; only the first two digits of the exponent
+are used.  Negative signs preceding both the decimal number and the exponent
 are recognized."
 
   (if (string-match floating-point-regexp str 0)
@@ -448,4 +453,6 @@ are recognized."
                  
     _f0))                              ; if invalid, return 0
 
+(provide 'float)
 
+;;; float.el ends here