Opened 7 years ago

Closed 7 years ago

#1288 closed defect (fixed)

[with patch] misformating of some of the reference manual in live version; also out of date

Reported by: was Owned by: mhansen
Priority: major Milestone: sage-2.9
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers:
Report Upstream: Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

See below. I suspect that the best solution is to remove this stuff about "sage -advanced" from the reference manual entirely, since it is always going to get out of date, hence be misleading. It's much better to just described how "sage -advanced" works, and suggest that the user try it out, then improve the output of "sage -advanced".

Reading 2.3 of the Reference Manual from the Notebook interface, I find that this "live" version has turned the lines:

\item
\verb+-advanced+ Lists additional options:

\begin{verbatim}
$ sage -advanced
in devel/doc-main/ref/options.tex into

<li><code>-advanced</code> Lists additional options:

<p>
<div class="verbatim"><pre><span class="math"> sage -advanced

in localhost:8000/doc/live/ref/node7.html , which, of course, completely wrecks the formatting.  There seems to be no problem with the pre-built  devel/doc-main/html/ref/node7.html , where latex2html has correctly turned the TeX into

<LI><code>-advanced</code> Lists additional options:

<P>
<div class="verbatim"><pre>
$ sage -advanced


Moreover, the list of options given in options.tex is considerably different from those currently produced by sage -advanced .


Mac OS X 10.4.11
Sage 2.8.14

-- 

Francis Clarke

Attachments (1)

1288-doc.patch (3.9 KB) - added by mhansen 7 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 7 years ago by mhansen

  • Owner changed from tba to mhansen
  • Status changed from new to assigned

Changed 7 years ago by mhansen

comment:2 Changed 7 years ago by mhansen

  • Milestone changed from sage-2.10 to sage-2.9
  • Summary changed from misformating of some of the reference manual in live version; also out of date to [with patch] misformating of some of the reference manual in live version; also out of date

comment:3 Changed 7 years ago by mabshoff

Looks good to me. Initially I was confused about this since it seemed to only remove content until I read William's comments.

Cheers,

Michael

comment:4 Changed 7 years ago by mabshoff

  • Resolution set to fixed
  • Status changed from assigned to closed

Merged in 2.9.alpha2.

Note: See TracTickets for help on using tickets.