Opened 13 years ago

Closed 13 years ago

#2924 closed defect (fixed)

[with patch; positive review] programming guide section on style is terrible! (very easy to fix)

Reported by: was Owned by: tba
Priority: major Milestone: sage-3.0
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers:
Report Upstream: Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

John Palmieri pointed out that

http://sagemath.org/doc/html/prog/node5.html

is completely wrong. In particular, it bizarrely mentions Scipy (??), and tells one to use lowercase for class names.

2.1 Coding Conventions
Follow the standard Python formatting rules when writing code for SciPy, as explained at http://www.python.org/doc/essays/styleguide.html. In particular,

    * Use 4 spaces for indentation levels. Do not use tabs as they can result in indentation confusion. Most editors have a feature that will insert 4 spaces when the tab key is hit. Also, many editors will automatically search/replace leading tabs with 4 spaces.

    * Use all lowercase function/class names with underscore separated words:

              def set_some_value()

      instead of:

              def setSomeValue()

      There is no differentiation between classes, functions, verbs, nouns, etc.

Attachments (1)

doc-2924.patch (1.4 KB) - added by was 13 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 13 years ago by was

  • Summary changed from programming guide section on style is terrible! to programming guide section on style is terrible! (very easy to fix)

Changed 13 years ago by was

comment:2 Changed 13 years ago by was

  • Summary changed from programming guide section on style is terrible! (very easy to fix) to [with patch; needs review] programming guide section on style is terrible! (very easy to fix)

comment:3 Changed 13 years ago by mhansen

  • Summary changed from [with patch; needs review] programming guide section on style is terrible! (very easy to fix) to [with patch; positive review] programming guide section on style is terrible! (very easy to fix)

Looks good to me.

comment:4 Changed 13 years ago by mabshoff

  • Resolution set to fixed
  • Status changed from new to closed

Merged in Sage 3.0.alpha5

Note: See TracTickets for help on using tickets.