Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

udpating documentation

  • Loading branch information...
commit 9b9a017dd81b2a77879d5a3a299365dc7a1d906b 1 parent e1a048d
@jarrodmillman jarrodmillman authored
Showing with 11 additions and 7 deletions.
  1. +8 −5 FORMAT_GUIDELINES.txt
  2. +3 −2 README.txt
View
13 FORMAT_GUIDELINES.txt
@@ -9,7 +9,7 @@ reminders follow:
o Only 80 characters on a line.
- o use all lowercase function/class names with underscore separated words:
+ o use all lowercase function names with underscore separated words:
def set_some_value()
@@ -17,8 +17,11 @@ reminders follow:
def setSomeValue()
- There is no differentiation between classes, functions, verbs, nouns, etc.
- This simple scheme aims to make it easier for non-programmers to become
- familiar with the interface. For those that object, you are skilled
- enough to deal with the limitation.
+ o use CamelCase class names:
+
+ def BaseClass()
+
+ instead of:
+
+ def base_class()
View
5 README.txt
@@ -98,7 +98,7 @@ follow the following conventions:
For details, read:
- http://svn.scipy.org/svn/numpy/trunk/numpy/doc/DISTUTILS.txt
+ http://projects.scipy.org/scipy/numpy/wiki/DistutilsDoc
Documentation
@@ -170,7 +170,7 @@ Mailing Lists
-------------
Please see the developer's list here
- http://projects.scipy.org/mailman/listinfo/scipy-devel
+ http://projects.scipy.org/mailman/listinfo/scipy-dev
Bug reports
@@ -189,3 +189,4 @@ License information
See the file "LICENSE" for information on the history of this
software, terms & conditions for usage, and a DISCLAIMER OF ALL
WARRANTIES.
+
Please sign in to comment.
Something went wrong with that request. Please try again.