diff options
author | Kevin Ryde <user42@zip.com.au> | 2005-01-15 00:03:53 +0000 |
---|---|---|
committer | Kevin Ryde <user42@zip.com.au> | 2005-01-15 00:03:53 +0000 |
commit | 6efaeb3567346bc97a3ddfbf9112670b15b4361d (patch) | |
tree | eac54631341e5fdbf2571ff3624279e625342b20 /libguile/random.c | |
parent | ba6e7231e49b21db034797929321dfe25bcc6167 (diff) | |
download | guile-6efaeb3567346bc97a3ddfbf9112670b15b4361d.tar.gz |
(scm_random_solid_sphere_x): Update docstring from manual.
Diffstat (limited to 'libguile/random.c')
-rw-r--r-- | libguile/random.c | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/libguile/random.c b/libguile/random.c index b1aff2d25..fde339adb 100644 --- a/libguile/random.c +++ b/libguile/random.c @@ -493,12 +493,11 @@ vector_sum_squares (SCM v) */ SCM_DEFINE (scm_random_solid_sphere_x, "random:solid-sphere!", 1, 1, 0, (SCM v, SCM state), - "Fills vect with inexact real random numbers\n" - "the sum of whose squares is less than 1.0.\n" - "Thinking of vect as coordinates in space of\n" - "dimension n = (vector-length vect), the coordinates\n" - "are uniformly distributed within the unit n-sphere.\n" - "The sum of the squares of the numbers is returned.") + "Fills @var{vect} with inexact real random numbers the sum of\n" + "whose squares is less than 1.0. Thinking of @var{vect} as\n" + "coordinates in space of dimension @var{n} @math{=}\n" + "@code{(vector-length @var{vect})}, the coordinates are\n" + "uniformly distributed within the unit @var{n}-sphere.") #define FUNC_NAME s_scm_random_solid_sphere_x { if (SCM_UNBNDP (state)) |