I'll address some of the issues with tut.tex. See
<http://trac.sagemath.org/sage_trac/ticket/3208>
for patches. (Some of these things have already been taken care of
there, and I'll post patches to others soon.)
Some of the things I'm not dealing with: I don't have Opera on my Mac,
and I'm not going to install it any time soon. I don't see any of the
garbled things that are reported here, so I can't do much about it.
I'm also not dealing with the mare's nest that is the reference
manual.
John
On May 17, 7:24 pm, "William Stein" <[EMAIL PROTECTED]> wrote:
> Hi Sage-Devel,
>
> Can somebody volunteer to make a trac ticket and put all the following
> fixes into sage?
>
> William
> Tutorial:
> 1. doc/live/tut/node9.html:
> Note: You should not type the triple dots ... above; they are just to
> emphasize that the code is indented.
> The dots do not appear in the HTML live notebook version. Ideally the
> tools would provide a way to omit some text in this version.
This can be done.
> If impossible write something like:
> Note: The interactive interpreter may display three dots ("...") to
> indicate that code is indented - these don't need to be entered.
> ---
> 2. doc/live/tut/node20.html:
> Type p.show(axes=false) to see this without any ases.
> ases => axes
This seems to have been changed already, at least in the copy of
tut.tex that I have.
> ---
>
> 3. doc/live/tut/node13.html
> Next lets do some arithmetic.
> suggest rather:
> Next, let's do some arithmetic.
Same here.
> ---
> 4. doc/live/tut/node23.html
> equatoins => equations
Same here
> ---
> 5. doc/live/tut/node24.html
> pari and maxima => PARI and Maxima
> The Sage notebook version displays
> &vellip#vdots;
> in the table (whether viewed in Opera for Mac version +- 9.5 or Safari
> 3.1). Just "⋮" might have worked. The static version exhibits
> the same problem.
I don't see this problem. I see "PARI and Maxima" in node28.html, but
no dots anywhere near there.
> ---
> 6. doc/live/tut/node40.html
> gap.console(): You are completely using another program, e.g., Gap/Magma/GP
> a. Add "." after "GP".
> b. Suggest replacing entire sentence with:
> gap.console(): This opens the GAP console, i.e. transfers control to GAP.
> as the phrase "completely using" is unclear.
Okay.
> c. Suggest replacing occurrences of "Gap" that refer to the GAP
> software with "GAP" --- this applies to this page and possibly other
> documentation files, perhaps search for the word Gap.
I don't see "Gap" anywhere in tut.tex.
> ---
> 7. doc/live/tut/node56.html
> Please note that you cannot do a stats = prun -r A*A for some internal reason.
> replace with
> Note: entering stats = prun -r A*A displays a syntax error message
> because prun is an IPython shell command, not a regular function.
Okay
> ---
> 8.
> See SAGE_ROOT/examples/pyrex/factorial.spyx for an example of a
> compiled implementation of the factorial function that directly uses
> the GMP C library
> Replace
> examples/pyrex
> with
> examples/programming/sagex
> as the file seems to have moved. Please confirm the exact directory
> name to list here as there are two instances of factorial.spyx shipped
> with v3.0.1.
Okay (fixed in earlier patch).
> ---
> 9. doc/live/tut/node46.html
> Suggest replacing
> In particular, attach has the side effect of (auto-reload), very handy
> when debugging code, while load does not.
> with
> The attach command automatically reloads a file whenever it changes,
> which is handy when debugging code, whereas the load command only
> loads a file once.
> as "(auto-reload)" is not defined anywhere (is this a LISP command?)
> and therefore might not make sense.
I see "In particular, {\em attach} has the side effect of auto-
reloading,
very handy when debugging code, while {\em load} does not." Anyway, I
can change it; the suggested wording seems a bit better to me.
> ---
> 10. doc/static/ref/node57.html
> Heierarchy => Hierarchy
> ---
> 11. doc/static/ref/node58.html
> DD NOT => DO NOT
> (IMHO "***NOT***" can be replaced with "NOT" - shouting (capital
> letters) should surely be enough? Alternatively render the NOT in
> bold.)
> ---
> 12. doc/static/ref/node18.html
> SAGE includes the Moin Moin Wiki interactive web page system standard.
> just omit " standard"
> -or-
> standard => as standard
> -or-
> standard => by default
> ---
> 13. doc/static/ref/module-sage.plot.plot.html
> We combine together => We combine
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> Intuitive usage and completeness notes
> The following are not really errors, just potential sources of confusion.
> 1. doc/live/tut/node10.html
> When reading
> the complex numbers CC (which uses I (or i), as usual, for the square
> root of −1).
> I tried
> (1+2*I) in CC
> (1+2*i) in CC
> and was surprised to receive False. Eventually I figured out one has
> to define I or i first.
> Suggest rather
> the complex numbers CC (which uses I (or i) for the square root of −1
> -- just enter I=CC.0 to define I).
Dealt in an earlier patch.
> ---
> 2. doc/live/tut/node10.html
> It might have been handy if
> optional_packages()
> and
> install_package('database_gap-4.4.10')
> were already executable blocks.
Don't know what's being referred to here. I don't see
'install_packages' anywhere in tut.tex.
> ---
> 3. doc/live/tut/node10.html
> I installed database_gap. The actual output of
> K.galois_group()
> and
> K.class_group()
> when evaluated were not what was pre-computed + stored in the
> tutorial. I was using sage 3.0.1 and database_gap 4.4.10.
I didn't install database_gap, because I didn't see the instruction in
tut.tex, and I got the answers listed in the tutorial (complete with
the odd phrase "Ring in a over Rational Field").
> ---
> 4. doc/live/tut/node13.html
> (The object MPolynomialRing(GF(5),3,"z") is the same as the object
> MPolynomialRing(GF(5),3,"z").)
I don't know what this is supposed to mean, either. I'll delete it.
> Oh, so x == x. Ah. Huh?
> ---
> 5. doc/live/tut/node16.html
> Next we compute its reduced row echelon form and kernel.
> Fine, but what is the A^20 about?
We can get rid of that.
> ---
> 6. doc/live/tut/node18.html
> You can also compute using abelian groups (infinite and finite):
> suggest (admittedly debatable):
> You can also compute using Abelian groups (infinite and finite):
> (If we write Euler and Dirac with initial capital letters we should
> also write Abel IMHO. Several other instances exist in the
> documentation.)
Mathematicians do this both ways. "abelian" is an accepted usage.
> ---
> 7. doc/live/tut/node28.html
> This page renders strangely in Opera +- 9.6 for Mac:
> SAGEROOT/ipythonrcfile.UponstartingSAGEyougetoutputsimilartothefollowing:−−
> −−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−|SAGEVersion1.5,Build
> Date:2006−12−11||DistributedundertheGNUGeneralPublicLicenseV2.|−−−−−−−−−−−−
> −−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−sage:ToquitSAGEeitherpressCtrl−
> Dortypequitorexit.
> all appears on one line. A grey box pops up in some cases containing
> clearer text. This phenomenon is referred to as garbled display in
> the rest of this email. This appears to be a bug in the HTML
> generation tool.
I don't have Opera, and I don't see any problems. I'm not even sure
which part of the document is being referred to, since my node numbers
differ from the ones listed here. Maybe node38.html? Looks okay to
me, and the html code looks okay too (text included in a <pre> block).
> ---
> 8. doc/live/tut/node29.html
> Suggest explaining that most of these constructs are not available in
> notebooks. (Because "_" worked in a notebook, I was wondering whether
> "_oh" and "%macro" etc also work.)
Okay
> Garbled display near
>
> The
> PATHhastheSAGEbindirectoryatthefront,soifyourungp,gap,singular,maxima,etc.,
> yougettheversionsincludedwithSAGE.
I don't see this. (I'm not even going to comment on the rest of the
"garbled" issues, since I don't see any of them.)
> ---
> 9. tut/node38.html
> Garbled display near
> sage[...]sage:b=19sage:loadsession(′misc′)LoadingaLoadingMLoadingELoadingt
> ---
> 10. doc/live/tut/node39.html
> Suggest documenting inotebook() too as it seems easier to get started with.
Don't think we need to do this anymore, do we?
> ---
> 11. doc/live/tut/node46.html
> Garbled display at
> HOME/.sage/temp/hostname/pid/spyx.ThesefilesaredeletedwhenyouexistSAGE.NOSA
> GEpreparsingisappliedtospyxfiles,e.g.,23meansexclusiveorratherthanpower.Iff
> ooisafunctionintheSAGElibrary,touseitfromaspyxfileimportsage.allandusesage.
> all.foo.importsage.alldeffoo(n):returnsage.all.factorial(n)TableofChild−Lin
> ksSubsections5.2.1AccessingCFunctionsinSeparateFilesEndofTableofChild−Links
> SAGETutorialPrevious:5.1LoadingandAttachingUp:5.ProgrammingNext:5.2.1Access
> ingCFunctionsRelease2007.10.28,documentationupdatedonOctober28,2007.EndofNa
> vigationPanelSeeAboutthisdocument...forinformationonsuggestingchanges.
> ---
> 12. FYI directory "sage/examples/programming/sagex" seems to contain
> several backup files (ending in "~") - should they have been shipped
> in the distribution? Several other directories contain these files.
> ---
> 13. When I executed
> /Applications/sage/local/bin/maxima
> the following was displayed:
> dyld: Library not loaded:
> /Users/clarita/Desktop/sage-2.8.11/local/lib/libreadline.5.2.dylib
> Referenced from:
> /Applications/sage/local/lib/maxima/5.13.0/binary-clisp/lisp.run
> Reason: image not found
> Trace/BPT trap
> I have installed libreadline.5.2.dylib in the standard MacPorts
> location (/opt/local/lib/libreadline.5.2.dylib) - would it somehow be
> possible to build maxima to look for shared libraries in the MacPorts
> standard location?
> (I was able to resolve this by entering
> export DYLD_LIBRARY_PATH=/opt/local/lib
> ./maxima
> but others might not know that they should do that.)
> ---
> 14. doc/live/tut/node49.html
> Garbled display:
> bash ./factor20062*17*59bash ./factor "32*x^5-1"
> (2*x - 1) * (16*x^4 + 8*x^3 + 4*x^2 + 2*x + 1)
> ---
> 15. doc/live/tut/node52.html
> A dictionary (also sometimes called an associative array) is a mapping
> from hashable objects to arbitrary objects.
> Suggest defining "hashable object".
I'll reword it. We'll see whether it's an improvement...
> ---
> 16. doc/live/tut/node55.html
> Part of the following
> the 1 in F5 to the 1∈Q
> did not display in Opera for Mac version +- 9.5 - refer to the
> attached screenshot. The static version of the documentation does
> display this correctly.
> ---
> 17. doc/static/ref/module-sage.structure.sequence.html
> a. Suggest inserting a few line breaks into the following:
> INPUT: x - a list or tuple instance universe - (default: None) the
> universe of elements; if None determined using canonical coercions and
> the entire list of elements. If list is empty, is category Objects()
> of all objects. check - (default: True) whether to coerce the elements
> of x into the universe cr - (default: False) if True, then print a
> carriage return after each comma when printing this sequence.
> b. The text below __str__( self) rendered with a strange indentation.
> ---
> 18. doc/static/ref/module-sage.sets.set.html
> The author log is inconsistent with other pages - other pages use:
> * Author Name: contribution he/she made
> Regards
> Johann
>
> --
> William Stein
> Associate Professor of Mathematics
> University of Washingtonhttp://wstein.org
--~--~---------~--~----~------------~-------~--~----~
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-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
