Permalink
Browse files

add note on subclassing to element.pm

  • Loading branch information...
1 parent 18d26b2 commit db4e40b84c34db205bd9a499a5e9f22a503d2f0c @jberger committed Oct 24, 2012
Showing with 1 addition and 1 deletion.
  1. +1 −1 lib/Physics/UEMColumn/Element.pm
@@ -60,7 +60,7 @@ A number representing the number of C<length>s away from the the center of the e
=item C<effect>
-Returns a hash reference of subroutine references defining the effect that the element has on a pulse's width (C<M_t>), length (C<M_z>) and velocity (C<acc_z>). These subroutine references expect arguments of time, pulse position and pulse velocty (C<t>, C<z>, C<v>), they return a number quantifying this effect.
+Returns a hash reference of subroutine references defining the effect that the element has on a pulse's width (C<M_t>), length (C<M_z>) and velocity (C<acc_z>). These subroutine references expect arguments of time, pulse position and pulse velocty (C<t>, C<z>, C<v>), they return a number quantifying this effect. The base class simply returns an empty hashreference. This method is meant to be redefined on subclassing.
=back

0 comments on commit db4e40b

Please sign in to comment.