Opened 9 years ago

Closed 9 years ago

#9861 closed enhancement (fixed)

Improving the Graph Theory table of contents

Reported by: ncohen Owned by: mvngu
Priority: major Milestone: sage-4.6
Component: documentation Keywords:
Cc: rlm, mvngu Merged in: sage-4.6.alpha1
Authors: Nathann Cohen, Minh Van Nguyen Reviewers: Minh Van Nguyen
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

The table of contents of the Graph Theory module is a bit hard to parse at the moment [1]. The file graph.py is even entitled "Graph Theory" itself, which must have remained from before this file was split into three, and the depth of 2 does not really help.

This patch is a possible way to clean it and make it.... readable ! I don't expect this patch to be merged as it is, as you probably have a different view of how it should be.. :-)

Nathann

[1] http://www.sagemath.org/doc/reference/graphs.html

Attachments (2)

trac_9861.patch (3.1 KB) - added by ncohen 9 years ago.
trac_9861-reviewer.patch (3.0 KB) - added by mvngu 9 years ago.

Download all attachments as: .zip

Change History (5)

Changed 9 years ago by ncohen

Changed 9 years ago by mvngu

comment:1 Changed 9 years ago by mvngu

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

I got these warnings after applying ncohen's patch to Sage 4.5.3.rc0:

/dev/shm/mvngu/sage-4.5.3/devel/sage/doc/en/reference/graphs.rst:36: (WARNING/2)
 Title underline too short.

Libraries of algorithms
--------------------
/dev/shm/mvngu/sage-4.5.3/devel/sage/doc/en/reference/graphs.rst:36: (WARNING/2)
 Title underline too short.

Libraries of algorithms
--------------------

These are fixed in my reviewer patch. The reviewer patch also adds some consistency to how module headings are named, and consistency on how to space headings in the index file graph.rst. Capitalized titles are more difficult to read than a title only whose first letter is capitalized. I have avoided capitalized titles.

I like ncohen's re-organized table of content for graph theory. Now it's just a matter of someone checking my reviewer patch. If it gets a positive review, then the whole ticket is good to go.

comment:2 Changed 9 years ago by ncohen

  • Authors changed from Nathann Cohen to Nathann Cohen, Minh Van Nguyen
  • Status changed from needs_review to positive_review

Great ! Thank you again for your help ! :-)

Nathann

comment:3 Changed 9 years ago by mpatel

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