#11491 closed defect (fixed)
Minor doc formatting problem in tachyon_repr
Reported by: | kcrisman | Owned by: | mvngu |
---|---|---|---|
Priority: | trivial | Milestone: | sage-4.7.1 |
Component: | documentation | Keywords: | beginner graphics format sd31 |
Cc: | mvngu, jason, ryan | Merged in: | sage-4.7.1.alpha4 |
Authors: | Ryan Grout | Reviewers: | Karl-Dieter Crisman |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
In plot3d/base.pyx, there is a problem with a missing line or something, so that the html doc for Graphics3D.tachyon_repr
looks bad. Should be very easy to fix.
Attachments (2)
Change History (14)
comment:1 Changed 8 years ago by
- Keywords sd31 added
- Status changed from new to needs_review
comment:2 Changed 8 years ago by
There is only one documentation. You just do ./sage -docbuild reference html
with the new one and check that it's right. End of fun :)
comment:3 Changed 8 years ago by
- Reviewers set to Karl-Dieter Crisman
This looks fine, though you must have fixed a lot of other newlines.
For some reason I can't get this to update the doc. The patch is correct, but seems to not be working right in terms of getting Sage to "see" it. I've had this problem other times with Sphinx, so I am tempted to give it positive review anyway. Currently building pdf doc to see what happens.
comment:4 Changed 8 years ago by
- Status changed from needs_review to needs_work
The pdf doesn't look right either, even though I built that from scratch. I really have no idea why this doesn't work, but 'needs work'.
Can you make a minimal patch, with just that new line?
Changed 8 years ago by
comment:5 Changed 8 years ago by
- Status changed from needs_work to needs_review
updated patch. Had to use a raw string (which should have been used in the first place). If needed, I will make all the docstrings in base.pyx to be rawstrings.
comment:6 Changed 8 years ago by
- Status changed from needs_review to positive_review
I could not get it to update properly on my computer - Sphinx would not "see" that the file changed - but it looks fine on Ryan's computer, and the code is correct. Positive review.
Changed 8 years ago by
comment:7 follow-up: ↓ 10 Changed 8 years ago by
I fixed some issues with my editor removing trailing spaces at the end of lines. Prevented patch from #2100 from applying cleanly.
comment:8 Changed 8 years ago by
- Description modified (diff)
comment:9 Changed 8 years ago by
- Merged in set to sage-4.7.1.alpha4
- Resolution set to fixed
- Status changed from positive_review to closed
comment:10 in reply to: ↑ 7 Changed 8 years ago by
- Description modified (diff)
comment:11 follow-up: ↓ 12 Changed 8 years ago by
So the patch in alpha4 is trac_11491_tachyon_repr.patch, correct? Just want to make sure, as it affects #2100.
I'm not sure how to test this...I can't seem to figure out how to build documentation for different branches of sage.