Ticket #5808 (closed defect: fixed)
[with patch, positive review] fix most warnings when building the reference manual
| Reported by: | jhpalmieri | Owned by: | jhpalmieri |
|---|---|---|---|
| Priority: | minor | Milestone: | sage-3.4.1 |
| Component: | documentation | Keywords: | |
| Cc: | Work issues: | ||
| Report Upstream: | Reviewers: | ||
| Authors: | Merged in: | ||
| Dependencies: | Stopgaps: |
Description
Along with #5541, this patch fixes most of the warnings when building the reference manual in 3.4.1.rc3. I still get these:
checking consistency... WARNING: /Applications/sage_builds/sage-3.4.1.rc3/devel/sage-test/doc/en/reference/sage/combinat/family.rst:: document isn't included in any toctree done preparing documents... WARNING: html_favicon is not an .ico file
but that's it.
Attachments
-
trac_5808-review.patch
(19.0 KB) -
added by cremona 4 years ago.
- Apply after the first patch
-
ref-warnings.patch
(35.4 KB) -
added by jhpalmieri 4 years ago.
- apply only this patch
Change History
comment:2 Changed 4 years ago by cremona
- Summary changed from [with patch, needs review] fix most warnings when building the reference manual to [with second patch, with positive review] fix most warnings when building the reference manual
Applies fine to 3.4.1.rc3. When I did "sage -docbuild all html" I got lots of warnings in the tutrial (ok, not dealt with here) and a couple in algebras/quatalg/quaternion_algebra.py.
So I added some edits to that file, as in the second patch attached.
My positive review applies to the first patch. If John likes the second one, that's good.
comment:3 follow-up: ↓ 4 Changed 4 years ago by jhpalmieri
Hi John,
I think your patch to quaternion_algebra.py is going to clash with the one at #5541, mentioned in the summary above.
comment:4 in reply to: ↑ 3 Changed 4 years ago by cremona
- Summary changed from [with second patch, with positive review] fix most warnings when building the reference manual to [with patch, with positive review] fix most warnings when building the reference manual
Replying to jhpalmieri:
Hi John,
I think your patch to quaternion_algebra.py is going to clash with the one at #5541, mentioned in the summary above.
OK, kill that patch, I should not have wasted my time!
I'm about to add a patch doing what you suggested for mwrank. Which will make 4933 even harder to merge...so on second thoughts I will not post it here but will rebase my #4933 patch on this one and include the mwrank changes there.
UPSHOT: Positive review for ref-warnings.patch; ignore the seond one.
comment:5 follow-up: ↓ 6 Changed 4 years ago by jhpalmieri
Okay, thanks, and sorry for the extra work you'll have to do rebasing.
comment:6 in reply to: ↑ 5 Changed 4 years ago by cremona
Replying to jhpalmieri:
Okay, thanks, and sorry for the extra work you'll have to do rebasing.
No problem -- done!
comment:7 Changed 4 years ago by jhpalmieri
- Summary changed from [with patch, with positive review] fix most warnings when building the reference manual to [with patch, needs review] fix most warnings when building the reference manual
This version removes the "..link::" directives from sudoku.py; otherwise, it's identical to the previous patch.
comment:8 Changed 4 years ago by jhpalmieri
mabshoff: the only issue with the latest patch is whether it passes doctests. I think it does; if you agree, I think you can re-issue the positive review.
comment:9 Changed 4 years ago by mabshoff
- Summary changed from [with patch, needs review] fix most warnings when building the reference manual to [with patch, positive review] fix most warnings when building the reference manual
With only ref-warnings.patch applied doctests do pass. So I am reinstating the positive review.
Cheers,
Michael
comment:10 Changed 4 years ago by mabshoff
- Status changed from new to closed
- Resolution set to fixed
Merged in Sage 3.4.1.rc4.
Cheers,
Michael
John,
I just uploaded a patch at #4933 which fixes some of the same things for ell_rational_field and ell_generic. We might have difficulties merging these. I am about to test yours and hope to give a positive review shortly...
PS I would like to add \AA and \PP to the "blackboard bold" list (for affine and projective space). I read your clear instructions on how to do that, but have not done so as I thought you were probably touching that file.