Opened 12 years ago
Closed 4 years ago
#9252 closed defect (invalid)
documentation errors in tutorial
Reported by: | William Laffin | Owned by: | William Laffin |
---|---|---|---|
Priority: | trivial | Milestone: | sage-duplicate/invalid/wontfix |
Component: | documentation | Keywords: | |
Cc: | Karl-Dieter Crisman, Erik Bray, Travis Scrimshaw | Merged in: | |
Authors: | William Laffin | Reviewers: | |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
$'s are not escaped, multilines appear wrong, etc.
This patches the tutorial plus others so that reading the live-help leaves one with less papercuts.
Attachments (2)
Change History (15)
Changed 12 years ago by
Attachment: | trac9252.patch added |
---|
comment:1 Changed 12 years ago by
Status: | new → needs_work |
---|
Changed 12 years ago by
Attachment: | trac9252.1.patch added |
---|
comment:2 Changed 12 years ago by
Authors: | → William Laffin |
---|---|
Description: | modified (diff) |
Status: | needs_work → needs_review |
comment:3 follow-up: 4 Changed 12 years ago by
Status: | needs_review → needs_work |
---|
I don't think this works with the static documentation; the backslashes that you've inserted are visible there.
comment:4 follow-up: 5 Changed 12 years ago by
Replying to jhpalmieri:
I don't think this works with the static documentation; the backslashes that you've inserted are visible there.
When you(or really anyone) says "static version" do they mean the pdf's? Would I be able to see them with
sage -docbuild tutorial pdf
?
On that note, where is the code that adds the $$=latex hack to the documentation? Maybe I can just patch that a little instead.
What about the literal blocks that are meant for the interactive shell? 'sage:' always gets turned into a cell, so I needed to add some kind of header in the literal block (a bad hack) to get it to print correctly in the live-help.
Thanks for looking at my patch!
comment:5 Changed 12 years ago by
Replying to wjlaffin:
When you(or really anyone) says "static version" do they mean the pdf's?
No, the html version. From the command line, execute "tutorial()", or from the notebook click the "Help" button and then the button for "Fast Static Versions of the Documentation". Then click on the word "Tutorial". Or open the file SAGE_ROOT/devel/sage/doc/output/html/en/tutorial/index.html in your web browser.
On that note, where is the code that adds the $$=latex hack to the documentation? Maybe I can just patch that a little instead.
What about the literal blocks that are meant for the interactive shell? 'sage:' always gets turned into a cell, so I needed to add some kind of header in the literal block (a bad hack) to get it to print correctly in the live-help.
Some of this is in sage/sage/misc/sagedoc.py (e.g., process_dollars
). See also SAGE_ROOT/devel/sage/doc/common/conf.py.
It looks like the conversion from the html file to the "live" version of the docs is in the notebook code: SAGE_ROOT/local/lib/python/site-packages/sagenb-0.8-py2.6.egg/sagenb/notebook/docHTMLProcessor.py, it looks like. Since you're dealing with differences between the static and the live versions, you may need to look there.
comment:6 Changed 9 years ago by
Milestone: | sage-5.11 → sage-5.12 |
---|
comment:7 Changed 9 years ago by
Milestone: | sage-6.1 → sage-6.2 |
---|
comment:8 Changed 9 years ago by
Milestone: | sage-6.2 → sage-6.3 |
---|
comment:9 Changed 8 years ago by
Milestone: | sage-6.3 → sage-6.4 |
---|
comment:10 Changed 8 years ago by
Cc: | Karl-Dieter Crisman added |
---|
comment:11 Changed 4 years ago by
Cc: | Erik Bray Travis Scrimshaw added |
---|---|
Status: | needs_work → needs_info |
obsolete, probably ?
comment:12 Changed 4 years ago by
Milestone: | sage-6.4 → sage-duplicate/invalid/wontfix |
---|---|
Status: | needs_info → positive_review |
Yes, I think so. Let's close it.
comment:13 Changed 4 years ago by
Resolution: | → invalid |
---|---|
Status: | positive_review → closed |
Whops. Forgot to test that. Disregard the first one.