Opened 6 years ago
Closed 6 years ago
#17616 closed enhancement (fixed)
Cleanup in the thematic tutorials
Reported by: | ncohen | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-6.5 |
Component: | documentation | Keywords: | |
Cc: | kcrisman, jhpalmieri | Merged in: | |
Authors: | Nathann Cohen | Reviewers: | Marc Mezzarobba |
Report Upstream: | N/A | Work issues: | |
Branch: | d780d12 (Commits) | Commit: | d780d129c4025a379704212186f96de174c02834 |
Dependencies: | #17615 | Stopgaps: |
Description (last modified by )
This branch reorders the index of thematic tutorials.
http://www.sagemath.org/doc/thematic_tutorials/
Currently, the hierarchy is not very clear between section/subsections, and very big titles have one or two entries (like "geometry").
This branch flattens it a bit, and reorders it:
- "Programming and Design" is renamed to "Introduction to Sage" (right after 'Introduction to Python')
- 'coding theory' is moved to 'combinatorics' (it had a section of its own before)
- 'Modeling mathematics on a computer' is renamed to '!Parents/!Elements, Categories and algebraic structures' (the whole of Sage is about modelling mathematics, from symbolics to graph theory)
- A short table of contents is added in the "categories primer" http://www.sagemath.org/doc/reference/categories/sage/categories/primer.html
- Same for "group theory" http://www.sagemath.org/doc/thematic_tutorials/group_theory.html#group-theory
- Importantly, all doctests of the "coding theory" tutorial were disabled for they began with "Sage :". I changed that, but there are many broken doctests that I cannot fix myself. This is ticket #17617.
Nathann
Change History (23)
comment:1 Changed 6 years ago by
- Branch set to public/17616
- Status changed from new to needs_review
comment:2 Changed 6 years ago by
- Commit set to 89bd62177f9bfc8f6a667ab63b4f1c7dab7775cc
comment:3 Changed 6 years ago by
- Dependencies changed from #17614 to #17615
comment:4 Changed 6 years ago by
- Description modified (diff)
comment:5 Changed 6 years ago by
- Description modified (diff)
comment:6 follow-up: ↓ 7 Changed 6 years ago by
- Reviewers set to Marc Mezzarobba
This mostly looks good to me, but
- what is the reason for changing "new algebraic structures" to "new algebraic structure" in
coercion_and_categories.rst
? - perhaps it would be worth linking to your follow-up ticket in the broken doctests that you marked with
not tested
comment:7 in reply to: ↑ 6 ; follow-up: ↓ 10 Changed 6 years ago by
Yooooooooo !
This mostly looks good to me, but
- what is the reason for changing "new algebraic structures" to "new algebraic structure" in
coercion_and_categories.rst
?
Adding typos make it easier for newcomers to make their first contributions.
- perhaps it would be worth linking to your follow-up ticket in the broken doctests that you marked with
not tested
I do not understand what change you request.
Nathann
(I will push a commit in a second to add this 's')
comment:8 Changed 6 years ago by
- Commit changed from 89bd62177f9bfc8f6a667ab63b4f1c7dab7775cc to d121ef2211777d0d1a7031386fbf10c77617c380
Branch pushed to git repo; I updated commit sha1. New commits:
d121ef2 | trac #17616: Typo
|
comment:9 Changed 6 years ago by
- Commit changed from d121ef2211777d0d1a7031386fbf10c77617c380 to 6f74cb98628bddff610c3c367b7e92543b288454
Branch pushed to git repo; I updated commit sha1. New commits:
6f74cb9 | #17616: link to #17617 in temporarily disabled doctests
|
comment:10 in reply to: ↑ 7 ; follow-up: ↓ 11 Changed 6 years ago by
Replying to ncohen:
I do not understand what change you request.
Sorry if I wasn't clear. I committed the change I had in mind.
comment:11 in reply to: ↑ 10 Changed 6 years ago by
Sorry if I wasn't clear. I committed the change I had in mind.
Oh I see. Well, I don't see anything wrong with that.
Nathann
comment:12 Changed 6 years ago by
- Status changed from needs_review to positive_review
comment:13 Changed 6 years ago by
Thaaaaaaaanks !
comment:14 Changed 6 years ago by
Conflicts, probably with #17614
comment:15 Changed 6 years ago by
- Status changed from positive_review to needs_work
comment:16 Changed 6 years ago by
- Commit changed from 6f74cb98628bddff610c3c367b7e92543b288454 to 90a576af0c46d840505f145243bb1e41e7866751
comment:17 Changed 6 years ago by
- Status changed from needs_work to positive_review
comment:18 Changed 6 years ago by
- Commit changed from 90a576af0c46d840505f145243bb1e41e7866751 to e1f7d372f767027c6ee8135c80585726ac028633
- Status changed from positive_review to needs_review
comment:19 Changed 6 years ago by
- Status changed from needs_review to positive_review
comment:20 Changed 6 years ago by
- Status changed from positive_review to needs_work
sage -t --long --warn-long 40.6 src/doc/en/thematic_tutorials/coding_theory.rst ********************************************************************** File "src/doc/en/thematic_tutorials/coding_theory.rst", line 87, in doc.en.thematic_tutorials.coding_theory Failed example: C = best_known_linear_code(6,3,GF(2)) Exception raised: Traceback (most recent call last): File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 488, in _run self.compile_and_execute(example, compiler, test.globs) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 850, in compile_and_execute exec(compiled, globs) File "<doctest doc.en.thematic_tutorials.coding_theory[2]>", line 1, in <module> C = best_known_linear_code(Integer(6),Integer(3),GF(Integer(2))) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/coding/linear_code.py", line 437, in best_known_linear_code C = gap("BestKnownLinearCode(%s,%s,GF(%s))"%(n,k,q)) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/interfaces/interface.py", line 199, in __call__ return cls(self, x, name=name) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/interfaces/expect.py", line 1307, in __init__ self._name = parent._create(value, name=name) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/interfaces/interface.py", line 389, in _create self.set(name, value) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/interfaces/gap.py", line 1305, in set out = self._eval_line(cmd, allow_use_file=True) File "/mnt/disk/home/release/Sage/local/lib/python2.7/site-packages/sage/interfaces/gap.py", line 771, in _eval_line raise RuntimeError(message) TypeError: Gap produced error output Error, Variable: 'BestKnownLinearCode' must have a value executing $sage4:=BestKnownLinearCode(6,3,GF(2));;
comment:21 Changed 6 years ago by
- Commit changed from e1f7d372f767027c6ee8135c80585726ac028633 to d780d129c4025a379704212186f96de174c02834
Branch pushed to git repo; I updated commit sha1. New commits:
d780d12 | trac #17616: Broken doctest
|
comment:22 Changed 6 years ago by
- Status changed from needs_work to positive_review
Sorry :-/
Nathann
comment:23 Changed 6 years ago by
- Branch changed from public/17616 to d780d129c4025a379704212186f96de174c02834
- Resolution set to fixed
- Status changed from positive_review to closed
Branch pushed to git repo; I updated commit sha1. New commits:
trac #17614: Move numerical_sage to thematic_tutorials (and only that)
trac #17614: Update the links
trac #17615: Move bordeaux_2008 into thematic_tutorials/explicit_methods_in_number_theory/ (and only that)
trac #17615: Update the links
trac #17616: Cleanup in the thematic tutorials