[Scipy-svn] r3355 - trunk

[scipy-svn at scipy.org]

Author: jarrod.millman
Date: 2007-09-22 21:16:58 -0500 (Sat, 22 Sep 2007)
New Revision: 3355

Modified:
   trunk/FORMAT_GUIDELINES.txt
   trunk/README.txt
Log:
udpating documentation


Modified: trunk/FORMAT_GUIDELINES.txt
===================================================================
--- trunk/FORMAT_GUIDELINES.txt	2007-09-23 01:36:55 UTC (rev 3354)
+++ trunk/FORMAT_GUIDELINES.txt	2007-09-23 02:16:58 UTC (rev 3355)
@@ -9,7 +9,7 @@
 
    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 @@
 
         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()

Modified: trunk/README.txt
===================================================================
--- trunk/README.txt	2007-09-23 01:36:55 UTC (rev 3354)
+++ trunk/README.txt	2007-09-23 02:16:58 UTC (rev 3355)
@@ -98,7 +98,7 @@
 
 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 @@
 -------------
 
 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 @@
 See the file "LICENSE" for information on the history of this
 software, terms & conditions for usage, and a DISCLAIMER OF ALL
 WARRANTIES.
+