From 1dee5e34a3d397eb96db0b6bcc8e9cb9858975d0 Mon Sep 17 00:00:00 2001
From: marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sat, 8 May 2010 04:50:09 +0000
Subject: * error.c: RDoc for subclasses of Exception. [ruby-core:28394]

* cont.c: ditto

* enumerator.c: ditto

* io.c: ditto

* math.c: ditto

* numeric.c: ditto

* proc.c: ditto

* re.c: ditto

* thread.c: ditto

* transcode.c: ditto. Thanks to Run Paint for some of the documentation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27671 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 math.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'math.c')

diff --git a/math.c b/math.c
index 8601b614e7..3d673129bd 100644
--- a/math.c
+++ b/math.c
@@ -734,6 +734,22 @@ exp1(sinh)
 exp1(sqrt)
 
 
+/*
+ *  Document-class: Math::DomainError
+ *
+ *  Raised when a mathematical function is evaluated outside of its
+ *  domain of definition.
+ *
+ *  For example, since +cos+ returns values in the range -1..1,
+ *  its inverse function +acos+ is only defined on that interval:
+ *
+ *     Math.acos(42)
+ *
+ *  <em>produces:</em>
+ *
+ *     Math::DomainError: Numerical argument is out of domain - "acos"
+ */
+
 /*
  *  The <code>Math</code> module contains module functions for basic
  *  trigonometric and transcendental functions. See class
-- 
cgit v1.2.3