improve documentation for projective normalize_coordinates

[bhutz]

For some base rings (such as polynomial rings over a field), the output of the function may seem counter intuitive even though the gcd is correct. The documentation is inadequate to describe this situation.

Component: algebraic geometry

Keywords: sage-days55, days54

Author: Ben Hutz

Reviewer: Travis Scrimshaw

Merged: sage-5.13.beta3

Issue created by migration from https://trac.sagemath.org/ticket/15377

[bhutz]

comment:1

added doumentation and examples. Cleaned up formatting of examples.

[tscrim]

comment:2

One thing for line 394; instead of "Beware" (or "Be aware"), I think this would be best formatted as

.. WARNING::

    The gcd depends on the base ring.

After this it will be a positive review.

Edit - one other thing, could you remove the comma , from line 449.

Best,

Travis

[sagetrac-atowsley]

comment:4

It fixed the typo and clarified the functionality.

Examples do what they should.

doctest looks good.

-Adam

[tscrim]

comment:5

I missed this the first go-around but you need to have a proper commit message.

Also why did you choose not to use the .. WARNING:: for the gcd dependency on the base ring?

[bhutz]

comment:6

opps. I forgot the commit message. The warning field is a good suggestion and has now been implemented for this patch.

[tscrim]

comment:7

Last thing; I noticed (I edited my first comment) is that the comma here

A polynomial ring over a ring, gives the more intuitive result.

should be removed. Thanks!

[bhutz]

Attachment: trac_15377_improve_documentation_normalize_coordinates.patch.gz

comma removed

[tscrim]

Changed keywords from sage-days55 to sage-days55, days54

[tscrim]

Author: Benjamin Hutz

[tscrim]

Reviewer: Travis Scrimshaw

[tscrim]

comment:8

Positive review. Thanks.

[jdemeyer]

Merged: sage-5.13.beta3

[fchapoton]

Changed author from Benjamin Hutz to Ben Hutz