#8825: Improve documentation for function norm
------------------------------------------------+---------------------------
Reporter: johan | Owner: jason
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-4.4.1
Component: documentation | Keywords:
Author: Johan Grönqvist, Minh Van Nguyen | Upstream: N/A
Reviewer: Minh Van Nguyen | Merged:
Work_issues: |
------------------------------------------------+---------------------------
Changes (by newvalueoldvalue):
* reviewer: => Minh Van Nguyen
* author: Johan Grönqvist => Johan Grönqvist, Minh Van Nguyen
Old description:
> The documentation for the function norm currently does not mention that
> different kinds of norms are used for complex numbers and vectors of
> complex numbers.
>
> I was very surprised that for a complex number z,
> norm(z) == norm(vector([z]))^2^, and no hint of this is available from
> the documentation available through executing "sage: norm?".
>
> See this [http://groups.google.com/group/sage-
> devel/browse_thread/thread/9f941378a95c0191 sage-devel] thread for some
> background information.
New description:
The documentation for the function norm currently does not mention that
different kinds of norms are used for complex numbers and vectors of
complex numbers.
I was very surprised that for a complex number z,
norm(z) == norm(vector([z]))^2^, and no hint of this is available from the
documentation available through executing "sage: norm?".
See this [http://groups.google.com/group/sage-
devel/browse_thread/thread/9f941378a95c0191 sage-devel] thread for some
background information.
Apply patches in this order:
1. #8819
1. #8831
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8825/trac_8825_norm_docstring.patch
trac_8825_norm_docstring.patch]
1. [http://trac.sagemath.org/sage_trac/attachment/ticket/8825/trac_8825
-more-norm-doc.patch trac_8825-more-norm-doc.patch]
--
Comment:
I'm happy with the patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8825/trac_8825_norm_docstring.patch
trac_8825_norm_docstring.patch]. To prevent further confusion regarding
how the norm function is defined for various objects, I have added more
documentation for various norm functions. The new documentation also cross
references between norm functions. So only my patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8825/trac_8825-more-
norm-doc.patch trac_8825-more-norm-doc.patch] needs review by anyone but
me. If it gets a positive review, the whole ticket is good to go.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8825#comment:2>
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.
