#5416: [with patch, positive review] miscellaneous documentation fixes
---------------------------+------------------------------------------------
Reporter: cwitty | Owner: cwitty
Type: defect | Status: new
Priority: major | Milestone: sage-3.4
Component: documentation | Keywords:
---------------------------+------------------------------------------------
Comment(by mvngu):
REFEREE REPORT
[[BR]][[BR]]
The patch '''misc-doc-fixes.patch''' applied OK against 3.4.alpha0 and the
documentation built OK with the command:
{{{
sage -docbuild all html
}}}
I rebuilt the entire set of documentation because the patch touches files
spanning the reference manual, the tutorial, the programming guide, and so
on. Although the patch fixes a load of formatting issues and typos, I can
still see (in the patch itself) that some typos are not fixed. I'm not
saying that the patch introduces any new formatting issues or typos; just
that it misses some that I can see in the patch itself. For example, the
patch has the following line to fix {{{sage/rings/polynomial/pbori.pyx}}}:
{{{
@@ -1148,7 +1148,7 @@
def _magma_init_(self, magma):
r"""
Return a a string which when evaluated with Magma returns a Magma
- representaion of this boolean polynomial ring.
+ representation of this boolean polynomial ring.
INPUT:
}}}
where one should note the line "Return a a string which". Another example
concerning the file {{{sage/rings/real_mpfi.pyx}}} that the patch touches:
{{{
@@ -3789,7 +3789,7 @@
# 1.6449340668482264364724151666460251892 # 64-bit
# Note that the number of bits of precision in the constructor
only
-# effects the internel precision of the pari number, not the
number
+# effects the internal precision of the pari number, not the
number
# of digits that gets displayed. To increase that you must
# use \code{pari.set_real_precision}.
}}}
Note the line
{{{
+# effects the internal precision of the pari number, not the
number
}}}
where "effects" should be "affects". I have no time to fix these now, but
if anyone does, please open another ticket for that. I can give this patch
a positive review for the problems that it fixes.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5416#comment:1>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
