Cleaning the Graph documentation index + remove numerical/test.py

[nathanncohen]

Some trivial changes are done in the documentation of graphs. The file numerical/test.py is also removed, as it seems to be a legacy of a previous era. It does not even test Sage but scipy, it appears nowhere and is not properly indented. And if we keep things whenever we do not know what it is there for we will end up with a lot of useless code :-P

Component: graph theory

Author: Nathann Cohen

Branch/Commit: fa1b01a

Reviewer: Frédéric Chapoton

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

[nathanncohen]

New commits:

88474db

trac #16398: Cleaning the Graph documentation index

[nathanncohen]

Commit: 88474db

[nathanncohen]

Branch: u/ncohen/16398

[fchapoton]

comment:2

Hello Nathann,

I have rebased on 6.3.beta3, and things look good to me, but I do not understand why you remove completely the file src/sage/numerical/test.py

Could you please explain why, or repair that if this was a mistake ?

---

New commits:

73a465b

Merge branch 'u/ncohen/16398' and 6.3.beta6

[fchapoton]

Changed commit from 88474db to 73a465b

[fchapoton]

Changed branch from u/ncohen/16398 to public/ticket/16398

[nathanncohen]

comment:3

Helloooooooooooooo !!

I have rebased on 6.3.beta3, and things look good to me, but I do not understand why you remove completely the file src/sage/numerical/test.py

Could you please explain why, or repair that if this was a mistake ?

I don't think I did this by mistake (I had mostly forgotten this patch :-P) but really I don't know what to do with this file.

1. It does not appear in the doc
2. It contains nothing but a doctest (not properly indented. I just checked that it was actually doctested when you do sage -t test.py and apparently it does)
3. It does not seem to test Sage but scipy
4. All the modifications done to this file since the beginning are just people changing the output of the doctests when some updates are made, or Jeroen adding a "# long time" flag.

Here's what I think: this file has been added in 2007 and nobody knows what it does anymore. If we don't remove it it will just stay there forever, just because nobody knows what exactly it does. At the very least we should move its content to an existing file somewhere, but really I think we should remove it as nobody knows what exactly it does.

Nathann

[fchapoton]

comment:4

Ok. I do not like when a ticket for something is used for something else. It reminds me of the national assembly using a law about agriculture to change the prize of the stamps, or something like that.

Nevertheless, I suppose that in the current case, I can still give a positive review, once the ticket description contains a complete and precise list of what it does, and the title is also changed accordingly.

[nathanncohen]

comment:5

Ok. I do not like when a ticket for something is used for something else. It reminds me of the national assembly using a law about agriculture to change the prize of the stamps, or something like that.

HMmmmm..... Only if you create a ticket for everything you end up with tickets doing really really stupid things. To me some things are not worth a ticket.

Nevertheless, I suppose that in the current case, I can still give a positive review, once the ticket description contains a complete and precise list of what it does, and the title is also changed accordingly.

Okayokay...

Nathann

[fchapoton]

comment:6

Thanks

[fchapoton]

Reviewer: Frédéric Chapoton

[nathanncohen]

comment:7

Thanks

That's my line :-)

Nathann

[vbraun]

comment:8

sage -t --long src/sage/graphs/digraph_generators.py
**********************************************************************
File "src/sage/graphs/digraph_generators.py", line 12, in sage.graphs.digraph_generators
Failed example:
    p = graphs.Circulant(10,[2,3])
Exception raised:
    Traceback (most recent call last):
      File "/scratch/buildbot/sage/redhawk-1/sage_git/build/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 480, in _run
        self.execute(example, compiled, test.globs)
      File "/scratch/buildbot/sage/redhawk-1/sage_git/build/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 839, in execute
        exec compiled in globs
      File "<doctest sage.graphs.digraph_generators[1]>", line 1, in <module>
        p = graphs.Circulant(Integer(10),[Integer(2),Integer(3)])
      File "lazy_import.pyx", line 326, in sage.misc.lazy_import.LazyImport.__getattr__ (build/cythonized/sage/misc/lazy_import.c:2837)
    AttributeError: GraphGenerators instance has no attribute 'Circulant'
**********************************************************************
1 item had failures:
   1 of   3 in sage.graphs.digraph_generators
    [81 tests, 1 failure, 8.25 s]

[sagetrac-git]

Changed commit from 73a465b to 155eb0e

[sagetrac-git]

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

155eb0e

trac #16398 correct failing doctest

[fchapoton]

comment:10

Sorry, for that. The doctest is now corrected.

[sagetrac-git]

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

fa1b01a

trac #16398: broken doctest

[sagetrac-git]

Changed commit from 155eb0e to fa1b01a

[nathanncohen]

comment:12

(I updated it again: this is the file for digraphs constructor, so the fix was graph->digraph ^^; Thank you very much though !)

[vbraun]

Changed branch from public/ticket/16398 to fa1b01a