search

sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.38k stars 469 forks source link

Cleanup in the thematic tutorials #17616

Closed 6bdad4c1-1e26-4f2f-a442-a01a2292c181 closed 9 years ago

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago

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:

Nathann

Depends on #17615

CC: @kcrisman @jhpalmieri

Component: documentation

Author: Nathann Cohen

Branch/Commit: d780d12

Reviewer: Marc Mezzarobba

Issue created by migration from https://trac.sagemath.org/ticket/17616

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago

Branch: public/17616

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Commit: 89bd621

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

4645442trac #17614: Move numerical_sage to thematic_tutorials (and only that)
612c3cftrac #17614: Update the links
c07c428trac #17615: Move bordeaux_2008 into thematic_tutorials/explicit_methods_in_number_theory/ (and only that)
3c4d499trac #17615: Update the links
89bd621trac #17616: Cleanup in the thematic tutorials
6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago

Changed dependencies from #17614 to #17615

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago

Description changed:

--- 
+++ 
@@ -18,6 +18,6 @@
 - 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. I will create another ticket for that.
+- 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
6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago

Description changed:

--- 
+++ 
@@ -10,7 +10,7 @@

 - '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)
+- '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
mezzarobba commented 9 years ago

Reviewer: Marc Mezzarobba

mezzarobba commented 9 years ago
comment:6

This mostly looks good to me, but

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago
comment:7

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')

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Changed commit from 89bd621 to d121ef2

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

d121ef2trac #17616: Typo
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

6f74cb9#17616: link to #17617 in temporarily disabled doctests
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Changed commit from d121ef2 to 6f74cb9

mezzarobba commented 9 years ago
comment:10

Replying to @nathanncohen:

I do not understand what change you request.

Sorry if I wasn't clear. I committed the change I had in mind.

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago
comment:11

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

6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago
comment:13

Thaaaaaaaanks !

vbraun commented 9 years ago
comment:14

Conflicts, probably with #17614

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Changed commit from 6f74cb9 to 90a576a

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

c949950trac #17615: Merged with 6.5.beta6
cf7b89atrac #17615: Broken doctest
90a576atrac #17616: Merged with updated #17615
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Changed commit from 90a576a to e1f7d37

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. This was a forced push. New commits:

21dbfd8trac #17615: Merged with 6.5.beta6
e4f3206trac #17615: Broken doctest
e1f7d37trac #17616: Merged with updated #17615
vbraun commented 9 years ago
comment:20
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));;
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Changed commit from e1f7d37 to d780d12

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 9 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

d780d12trac #17616: Broken doctest
6bdad4c1-1e26-4f2f-a442-a01a2292c181 commented 9 years ago
comment:22

Sorry :-/

Nathann

vbraun commented 9 years ago

Changed branch from public/17616 to d780d12