#12688: Improve documentation of span method
----------------------------------+-----------------------------------------
Reporter: rbeezer | Owner: jason, was
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-5.1
Component: linear algebra | Resolution:
Keywords: rd2, sd40.5 | Work issues:
Report Upstream: N/A | Reviewers: Andrey Novoseltsev
Authors: Rob Beezer | Merged in:
Dependencies: 12541 | Stopgaps:
----------------------------------+-----------------------------------------
Changes (by rbeezer):
* status: needs_work => needs_review
Old description:
> I discovered this while working on #12541. Documentation says the
> `check` will "coerce entries of gens into base field." This does not
> appear to be happening, and should. (Edit: this is an integral span of
> rational vectors, a construction that is intended, so improving the
> documentation might be in order.)
>
> {{{
> sage: (QQ^2).span(gens=[vector(QQ, [1,1/2])], base_ring=ZZ, check=True)
> Free module of degree 2 and rank 1 over Integer Ring
> Echelon basis matrix:
> [ 1 1/2]
> }}}
>
> '''Depends:''' #12541
>
> '''Apply:'''
> 1. [attachment:trac_12688_span_documentation.patch]
New description:
I discovered this while working on #12541. Documentation says the `check`
will "coerce entries of gens into base field." This does not appear to be
happening, and should. (Edit: this is an integral span of rational
vectors, a construction that is intended, so improving the documentation
might be in order.)
{{{
sage: (QQ^2).span(gens=[vector(QQ, [1,1/2])], base_ring=ZZ, check=True)
Free module of degree 2 and rank 1 over Integer Ring
Echelon basis matrix:
[ 1 1/2]
}}}
'''Depends:''' #12541
'''Apply:'''
1. [attachment:trac_12688_span_documentation.patch]
1. [attachment:trac_12688_span_documentation-update.patch]
--
Comment:
Replying to [comment:5 novoselt]:
Thanks again - comments addressed in "update" patch.
Rob
> Little picks:
> * "INPUTS" should be without "S" according to guidelines.
> * There also should be "OUTPUT" and perhaps it can precisely state here
where the resulting submodule lives.
>
> Otherwise looks good to me!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12688#comment:10>
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.
