[WIP][issue #178] documentation modified to insert parameter, and implementation modified to satisfy code conventions