[freeside-commits] freeside/FS/FS svc_Common.pm,1.37,1.38

[Ivan,,,]

Update of /home/cvs/cvsroot/freeside/FS/FS
In directory wavetail:/tmp/cvs-serv3011

Modified Files:
	svc_Common.pm 
Log Message:
doc

Index: svc_Common.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/svc_Common.pm,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -d -r1.37 -r1.38
--- svc_Common.pm	13 Sep 2006 02:11:14 -0000	1.37
+++ svc_Common.pm	29 Dec 2006 08:25:19 -0000	1.38
@@ -746,9 +746,13 @@
 
 =item cancel
 
-Stub - returns false (no error) so derived classes don't need to define these
+Stub - returns false (no error) so derived classes don't need to define this
 methods.  Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
 
+This method is called *before* the deletion step which actually deletes the
+services.  This method should therefore only be used for "pre-deletion"
+cancellation steps, if necessary.
+
 =cut
 
 sub cancel { ''; }