#11490: Add a thematic tutorial on coercion and categories
---------------------------------------------------------+------------------
Reporter: SimonKing | Owner:
mvngu
Type: enhancement | Status:
needs_review
Priority: major | Milestone:
sage-5.7
Component: documentation | Resolution:
Keywords: categories coercion thematic tutorial | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Simon King | Merged in:
Dependencies: #14084 | Stopgaps:
---------------------------------------------------------+------------------
Comment (by tscrim):
I also have the following comments:
- There's a typo on line 100: `This base class provides a lot mor methods
than a general parent::` (mor -> more).
- On line 133: `Declaring the base or base is easy` -- should that be "the
base of base ring"?
- On block starting at line 141, I would set the `_repr_` and like
functions in code formatting (double back ticks)
- In the `__cmp__` block, it might be worth noting that if `__cmp__` is
not implemented, bad things can happen when calling `cmp` (ex. #14065)
- The double colon on line 312, I believe it will not show up in the
documentation since I believe the newline will be treated as a whitespace.
- The block starting at line 319, the last sentence is `It not even gives
a wrong answer, but results in an error::`. I believe there should be a
"does".
- The `but they are *required* or *optional* methods` sentence on lines
435-436 sounds strange to me. I would recommend "so they are either
*optional* or *required* methods."
- The `.. note::` on line 580 should have a blank line following it
- On line 655, I think it should end with a bang {{{So, *don't be afraid
of using categories!*}}} (sorry couldn't resist the pun)
- I believe the title `Not any conversion is a coercion` on line 696
should be "Not every conversion is a coercion"
- For the 5 axioms starting on line 725, shouldn't everything align (the
blocks are one space less than the first line) for proper formatting?
- On line 793 there is a typo: `We have seen above that some onversions
into our` (onversions -> conversions)
- Note block on line 935 needs a newline
- The `.. warning::` block on line 1536 needs a newline
For the record, I was reading it from the patch file and didn't look at
the compiled doc, so some of these might be invalid.
One last thing, this is more from my personal taste, but I think the
note/warning blocks should be capitalized as `.. NOTE::` and `..
WARNING::` to be consistent with the dev guide.
I'm sorry this turned into a bit of a laundry list of things. Thank you
for this nice tutorial!
Best,[[BR]]
Travis
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11490#comment:11>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
