add a few comments as to the usage/assumptions of this module