#10111: random_prime is badly documented.
-----------------------------+----------------------------------------------
Reporter: drkirkby | Owner: mvngu
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.6.1
Component: documentation | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Description changed by drkirkby:
Old description:
> The {{{random_prime}}} function in Sage can take one, two or three
> arguments. But the only examples of using this function use only one
> argument.
>
> {{{
> sage: random_prime(100000)
> 88237
> sage: random_prime(2)
> 2
> }}}
>
> Although some with good Python knowledge may argue the behaviour with 2
> or 3 arguments is documented properly, I personally think it could be
> clearer.
>
> For example, I'm told:
> {{{
> random_prime(123,False)
> }}}
>
> would normally be written as
>
> {{{
> random_prime(123, proof=False)
> }}}
>
> It would be good with someone with decent Python knowledge to write some
> examples of using this function with 2 or 3 arguments.
New description:
The {{{random_prime()}}} function in Sage can take one, two or three
arguments. But all the examples shown in the documentation or
{{{random_prime}}} use only one argument. The more complex cases are not
documented and not tested.
See also
http://groups.google.com/group/sage-
devel/browse_thread/thread/6e8d6f28c915830d?hl=en
These are the examples given.
{{{
sage: random_prime(100000)
88237
sage: random_prime(2)
2
}}}
Although some with good Python knowledge may argue the behavior with 2 or
3 arguments is documented properly, I personally think it could be
clearer.
For example, I'm told:
{{{
random_prime(123,False)
}}}
would normally be written as
{{{
random_prime(123, proof=False)
}}}
It would be good with someone with decent Python knowledge to write some
examples of using this function with 2 or 3 arguments.
See also #10112, where it is shown that the function hangs for certain
erroneous inputs.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10111#comment:1>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
