commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject cvs commit: jakarta-commons/lang DEVELOPERS-GUIDE.html
Date Thu, 14 Aug 2003 00:21:23 GMT
scolebourne    2003/08/13 17:21:23

  Modified:    lang     DEVELOPERS-GUIDE.html
  Log:
  Add section on deprecations in javadoc
  
  Revision  Changes    Path
  1.6       +11 -4     jakarta-commons/lang/DEVELOPERS-GUIDE.html
  
  Index: DEVELOPERS-GUIDE.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/DEVELOPERS-GUIDE.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- DEVELOPERS-GUIDE.html	14 Aug 2003 00:08:14 -0000	1.5
  +++ DEVELOPERS-GUIDE.html	14 Aug 2003 00:21:23 -0000	1.6
  @@ -102,12 +102,19 @@
   It should be supported with an explanation within a normal paragraph.</p>
   
   <h4>Exception throwing</h4>
  -<p>When throwing an exception to indicate a bad argument, always throw 
  +<p>When throwing an exception to indicate a bad argument, always try to throw 
   IllegalArgumentException, even if the argument was null. Do not throw 
  -NullPointerException. </p>
  +NullPointerException. (Obviously, you should document what the code actually does!)</p>
  +
  +<h4>Deprecations</h4>
  +<p>When deprecating a method or class include a clear reference to when the method
will be deleted.
  +This should be of the form 'Method will be removed in Commons Lang 3.0.'.
   
   <h4>Language used in code/comments</h4>
  -<p>It has been decided to casually standardize on US-English. To avoid misplaced
jeers of 'americanisation', the people making this decision largely write in non-US-English.
However, it's not something to get worked up about. Lots of spelling differences will creep
in all over. </p>
  +<p>It has been decided to casually standardize on US-English.
  +To avoid misplaced jeers of 'americanisation', the people making this decision largely
write in non-US-English.
  +However, it's not something to get worked up about.
  +Lots of spelling differences will creep in all over.</p>
   
   </body>
   </html>
  
  
  

Mime
View raw message