#6765: Linear Programming in Tutorial's Tour !
-----------------------------+----------------------------------------------
Reporter: ncohen | Owner: tba
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-4.3
Component: documentation | Keywords:
Work_issues: | Author:
Reviewer: John Palmieri | Merged:
-----------------------------+----------------------------------------------
Changes (by jhpalmieri):
* status: needs_review => needs_work
* reviewer: => John Palmieri
Comment:
Some comments:
(1) When I run "sage -docbuild tutorial html", it complains
{{{
/Applications/sage/devel/sage/doc/en/tutorial/tour_LP.rst:64: (WARNING/2)
Title underline too short.
Variables in ``MixedIntegerLinearProgram``
""""""""""""""""""""""""""
}}}
The string of double quotes should line up exactly with the previous line.
(Maybe it's good enough it is at least as long, but I think it should be
the same length.)
(2) In a string like {{{minimized ( for example `2 x + y` )}}}, you
shouldn't have a space after {{{(}}} or before {{{)}}}: it should say
{{{minimized (for example `2 x + y`)}}}. This happens throughout the
document. Along the same lines, there should be no space before "?" or
before ":". Before a block of examples (like lines 69-70), I think you
want a visible colon, and you achieve that by having "::" with no
preceding space. (Using "::" with a preceding space signals a block of
examples but doesn't print a colon at all.)
(3) On line 75, "remperature" should presumably be "temperature". Try
running a spell check.
(4) You don't have a period at the sentence ending the paragraph "What is
a Mixed Integer Linear Program ?" I haven't done any more careful
proofreading, but you should check for other spelling, usage, and grammar
errors.
(5) In multiline doctests, you need to change "....:" to "...". As it
stands, doctesting bombs on these lines.
(6) If I don't have GLPK or numerical.MIP installed, doctests have to pass
anyway. Also, if I don't have them, I absolutely don't want doctesting to
try to install them, which the lines
{{{
sage: # To install GLPK
sage: install_package('glpk')
sage: # To install Coin-OR Branch and Cut ( CBC )
sage: install_package('cbc')
}}}
will do. Maybe mark those lines as "# not tested"?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6765#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 post to this group, send email to [email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=.
