Ticket #8786 (closed defect: fixed)

Opened 3 years ago

Last modified 3 years ago

graph.py: autogenerated broken links to Wikipedia

Reported by: was Owned by: mvngu
Priority: major Milestone: sage-4.4.2
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: N/A Reviewers: Minh Van Nguyen, Nathann Cohen
Authors: Minh Van Nguyen, Nathann Cohen Merged in: sage-4.4.2.alpha0
Dependencies: Stopgaps:

Description (last modified by mvngu) (diff)

This is in devel/sage/sage/graphs/graph.py:

class Graph(GenericGraph):
    r"""
    Undirected graph.

    A graph is a set of vertices connected by edges
    (cf. http://en.wikipedia.org/wiki/Graph_(mathematics) ).

If you look at  http://sagemath.org/doc/reference/sage/graphs/graph.html and search for "mathematics", then click the link, you'll see it is broken. Fix this by:

  1. fixing sphinx? too tricky, maybe
  1. finding sphinx docs and figuring out how to explicitly specify a URL.

Apply patches in the following order:

  1.  trac_8786-wikipedia-links.patch
  2.  trac_8786-other_fixes.2.patch
  3.  trac_8786-reviewer.patch

Attachments

trac_8786-wikipedia-links.patch Download (2.5 KB) - added by mvngu 3 years ago.
based on Sage 4.4
trac_8786-other_fixes.patch Download (7.5 KB) - added by ncohen 3 years ago.
trac_8786-other_fixes.2.patch Download (7.4 KB) - added by mvngu 3 years ago.
trac_8786-reviewer.patch Download (8.2 KB) - added by mvngu 3 years ago.

Change History

comment:1 Changed 3 years ago by mvngu

  • Summary changed from in graph.py, there is an autogenerated broken link to Wikipedia. replace it by something not autogenerated that works (probably trivial), or fix the url parser in sphinx (really hard) to graph.py: autogenerated broken links to Wikipedia

Changed 3 years ago by mvngu

based on Sage 4.4

comment:2 Changed 3 years ago by mvngu

  • Status changed from new to needs_review
  • Authors set to Minh Van Nguyen

The attached patch should fix the broken links in graph.py to Wikipedia. Any URL can be encapsulated using the markup:

`descriptive-name <valid-URL>`_

comment:3 Changed 3 years ago by ncohen

And here are a few more corrections (to be applied on top of Minh's)... Some were not a problem as they contained no parenthesis, but as I had an Emacs macro available... :-)

By the way, I noticed something funny while working on this patch :

~/sage/sage-doc/sage/graphs$ grep -e "def.*eedback" *
digraph.py:    def feedback_edge_set(self,value_only=False):
digraph.py:    def feedback_vertex_set(self,value_only=False):
generic_graph.py:    def feedback_edge_set(self,value_only=False):
generic_graph.py:    def feedback_vertex_set(self,value_only=False):
~/sage/sage-doc/sage/graphs$ 

It must have occurred during the splitting of graph.py... I'll create another ticket to take care of it :-)

Nathann

Changed 3 years ago by ncohen

Changed 3 years ago by mvngu

Changed 3 years ago by mvngu

comment:4 follow-up: ↓ 5 Changed 3 years ago by mvngu

  • Reviewers set to Minh Van Nguyen
  • Description modified (diff)
  • Authors changed from Minh Van Nguyen to Minh Van Nguyen, Nathann Cohen

The patch  trac_8786-other_fixes.2.patch is the same as  trac_8786-other_fixes.patch, but with the ticket number in its commit message. The reviewer patch  trac_8786-reviewer.patch contains the following changes:

So only the following patches now need review by anyone but me:

comment:5 in reply to: ↑ 4 Changed 3 years ago by ncohen

  • Status changed from needs_review to positive_review

So only the following patches now need review by anyone but me:

Then let this ticket be positively reviewed ! The patches are to be applied in this order :

And there is nothing wrong to report on alpha2. And I did not notice any other link we could have missed in the documentation :-)

Thank you very much, Minh !!

Nathann

comment:6 Changed 3 years ago by mvngu

  • Reviewers changed from Minh Van Nguyen to Minh Van Nguyen, Nathann Cohen

comment:7 Changed 3 years ago by mvngu

  • Status changed from positive_review to closed
  • Resolution set to fixed
  • Merged in set to sage-4.4.2.alpha0
Note: See TracTickets for help on using tickets.