Mercurial > octave-antonio
diff scripts/specfun/primes.m @ 20162:2645f9ef8c88 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed specfun, special-matrix, testfun, and time script directories.
* scripts/specfun/expint.m, scripts/specfun/isprime.m,
scripts/specfun/legendre.m, scripts/specfun/primes.m,
scripts/specfun/reallog.m, scripts/specfun/realsqrt.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m,
scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m,
scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m,
scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m,
scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m,
scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m,
scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m,
scripts/testfun/rundemos.m, scripts/testfun/runtests.m,
scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m,
scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m,
scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m,
scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 17:00:11 -0700 |
| parents | 4197fc428c7d |
| children |
line wrap: on
line diff
--- a/scripts/specfun/primes.m Sun May 03 15:36:23 2015 -0700 +++ b/scripts/specfun/primes.m Sun May 03 17:00:11 2015 -0700 @@ -20,14 +20,13 @@ ## @deftypefn {Function File} {} primes (@var{n}) ## Return all primes up to @var{n}. ## -## The output data class (double, single, uint32, etc.) is the same as -## the input class of @var{n}. The algorithm used is the Sieve of -## Eratosthenes. +## The output data class (double, single, uint32, etc.) is the same as the +## input class of @var{n}. The algorithm used is the Sieve of Eratosthenes. ## -## Notes: If you need a specific number of primes you can use the -## fact that the distance from one prime to the next is, on average, -## proportional to the logarithm of the prime. Integrating, one finds -## that there are about @math{k} primes less than +## Notes: If you need a specific number of primes you can use the fact that the +## distance from one prime to the next is, on average, proportional to the +## logarithm of the prime. Integrating, one finds that there are about +## @math{k} primes less than ## @tex ## $k \log (5 k)$. ## @end tex @@ -35,8 +34,7 @@ ## k*log (5*k). ## @end ifnottex ## -## See also @code{list_primes} if you need a specific number @var{n} of -## primes. +## See also @code{list_primes} if you need a specific number @var{n} of primes. ## @seealso{list_primes, isprime} ## @end deftypefn