#11682: thematic tutorial on sandpiles
-----------------------------+----------------------------------------------
Reporter: dperkinson | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.7.2
Component: documentation | Keywords: sandpile
Work_issues: | Upstream: N/A
Reviewer: | Author: David Perkinson
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Changes (by rbeezer):
* status: needs_info => needs_review
Comment:
Hi David,
This is very nice and all seems to be working pretty well as far as
patches and images and all that.
I have one doctest failure (same command twice, then a follow-on command
fails). I'm using 4.7.1.alpha4. It could be I am behind? Has this
changed? Which version are you testing on?
{{{
File "/sage/sage-4.7.1.alpha4/devel/sage-
main/doc/en/thematic_tutorials/sandpile.rst", line 4189:
sage: eff = D.effective_div()
Exception raised:
Traceback (most recent call last):
File "/sage/sage-4.7.1.alpha4/local/bin/ncadoctest.py", line 1231,
in run_one_test
self.run_one_example(test, example, filename, compileflags)
File "/sage/sage-4.7.1.alpha4/local/bin/sagedoctest.py", line 38, in
run_one_example
OrigDocTestRunner.run_one_example(self, test, example, filename,
compileflags)
File "/sage/sage-4.7.1.alpha4/local/bin/ncadoctest.py", line 1172,
in run_one_example
compileflags, 1) in test.globs
File "<doctest __main__.example_102[4]>", line 1, in <module>
eff = D.effective_div()###line 4189:
sage: eff = D.effective_div()
File "/sage/sage-4.7.1.alpha4/local/lib/python/site-
packages/sage/sandpiles/sandpile.py", line 4212, in effective_div
return deepcopy(self._effective_div)
File "/sage/sage-4.7.1.alpha4/local/lib/python/site-
packages/sage/sandpiles/sandpile.py", line 3551, in __getattr__
self._set_effective_div()
File "/sage/sage-4.7.1.alpha4/local/lib/python/site-
packages/sage/sandpiles/sandpile.py", line 4178, in _set_effective_div
r = self.linear_system()
File "/sage/sage-4.7.1.alpha4/local/lib/python/site-
packages/sage/sandpiles/sandpile.py", line 4157, in linear_system
return self._linear_system
File "/sage/sage-4.7.1.alpha4/local/lib/python/site-
packages/sage/sandpiles/sandpile.py", line 3549, in __getattr__
return self.__dict__[name]
KeyError: '_linear_system'
}}}
Same thing at line 4360.
Some comments on formatting, etc, in no particular order.
1. Other tutorials have a main title (in the index of tutorials) that is
capitalized, so maybe yours should be also.
2. Maybe "is in the works" could read as "will appear as"?
3. Installing 4ti2. Does it really need the patch level and all? I
thought it was smarter and {{{sage -i 4ti2}}} would grab the newest spkg?
4. URL references to other parts of the documentation should perhaps be
relative links, not full-blown {{{http://}}} style. Sage should not
presume an internet connection, and indeed, many may view the
documentation locally, especially if coming to it from within the
notebook. So
{{{
http://sagemath.org/doc/reference/sage/graphs/graph_generators.html
}}}
could become
{{{
../reference/sage/graphs/graph_generators.html
}}}
There are also ways to link to documentation for classes, modules,
functions, etc with syntax such as
{{{
:mod:`sage.graphs.graph_generators`
}}}
which might even work better (ask if you need help with this).
5. !SandpileConfig, !^ operator: needs a double-colon for the examples,
they are not being rendered verbatim.
6. Do you want triple-dashes to make full-width horizontal rules in your
lists of methods? I'm just getting a short stubby thing, maybe you need
more dashes?
7. Are Sage code examples in the "python blocks" being tested? (Break
one and see.) I don't know - I've never used this construct in writing
documentation. Doesn't matter either way, I think.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11682#comment:13>
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].
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.
