Opened 12 years ago

Closed 12 years ago

Last modified 12 years ago

#8733 closed enhancement (fixed)

documentation and stylistic clean-ups of c_graph.pyx

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

Status badges

Description (last modified by Minh Van Nguyen)

As the subject says. The goal here is to make the documentation of the module c_graph.pyx consistent and also to better document the module itself. The coding style of the whole module is inconsistent. Clean that up as well.

Attachments (1)

trac_8733-cgraph-cleanup.patch (84.5 KB) - added by Minh Van Nguyen 12 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 12 years ago by Minh Van Nguyen

Description: modified (diff)
Summary: clean up documentation of c_graph.pyxdocumentation and stylistic clean-ups of c_graph.pyx

comment:2 Changed 12 years ago by Minh Van Nguyen

Authors: Minh Van Nguyen
Status: newneeds_review

The method degree() in the class CGraphBackend of the module c_graph.pyx has a bug in its implementation. This issue is tracked at #8395.

Changed 12 years ago by Minh Van Nguyen

comment:3 Changed 12 years ago by Minh Van Nguyen

Changes proposed by the patch include:

  • Remove trailing white spaces.
  • Don't go over 79 characters wherever possible.
  • Cross link methods and classes.
  • Add more documentation to methods.
  • Stylistic clean-ups in accordance with PEP 8.
  • Use "in" instead of "has_key()" for dictionaries.

comment:4 Changed 12 years ago by Nathann Cohen

Status: needs_reviewpositive_review

Well.. What can I say besides "good work" ? :-)

Definitely cleaner, still passes all tests, the documentation is clearly improved, and I was responsible for some of the mistakes you corrected (the dictionaries, for examples) :-)

Positive review, and thank you very muuuuuuuuch !

Nathann

comment:5 Changed 12 years ago by Minh Van Nguyen

Reviewers: Nathann Cohen

comment:6 Changed 12 years ago by William Stein

Merged in: 4.4.1.alpha2
Resolution: fixed
Status: positive_reviewclosed

comment:7 Changed 12 years ago by Minh Van Nguyen

Merged in: 4.4.1.alpha2sage-4.4.1.alpha2
Note: See TracTickets for help on using tickets.