#6572: [with patch, needs review] tutorial: put double colon on its own line
---------------------------+------------------------------------------------
Reporter: mvngu | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-4.1.1
Component: documentation | Keywords: tutorial
Reviewer: | Author:
Merged: |
---------------------------+------------------------------------------------
Comment(by jhpalmieri):
Here are two patches, one for the main repository and one for the scripts
repository.
The scripts patch does the following: first, previously, doctests had to
be preceded by a double colon at the beginning of a line, and now they
only need to be preceded by a line which starts with white space then a
double colon -- the double colon no longer has to be at the left margin.
This is important for some files (like
constructions/algebraic_geometry.rst), in which indentations might break
if we had to move the double colons to the left. The second change is
figuring out when the doctest block ends: it looks for text indented no
farther than the double colons were. (Previously, it looked for text
which wasn't indented at all, so if a paragraph was indented, then some
doctests were indented further, then a paragraph unindented one level,
that second paragaph was treated as part of the doctest block.)
As a result of all of this, some more doctests are found by {{{sage -t}}}.
The other patch does two things: it makes the change advertised in the
summary for the ticket, moving double colons onto lines of their own where
necessary. It also tries to fix the newly discovered broken doctests. I
don't know how to fix some of these, and so they are being skipped. These
include the one which triggered this whole episode:
{{{
sage: theta = var('theta')
sage: solve(cos(theta)==sin(theta))
[sin(theta) == cos(theta)]
}}}
as well as some doctests involving starting and stopping the Singular
console, for example.
For me, this passes all tests on Mac OS X (both 32-bit and 64-bit), and
also on a 32-bit linux box (an old Ubuntu machine) and a 64-bit linux box
(sage.math). It would be best to fix the skipped tests, but that can go
in another ticket if no one knows how to do it right now.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6572#comment:2>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---