geocat.comp.gc_util._generate_wrapper_docstring

geocat.comp.gc_util._generate_wrapper_docstring#

geocat.comp.gc_util._generate_wrapper_docstring(wrapper_fcn, base_fcn)#

Generate the docstring for a wrapper function in the form of: ‘This method is a wrapper for base_fcn’, with a generated link to the base function.

Parameters:
  • wrapper_fcn (function) – The wrapper function to generate and assign a docstring

  • base_fcn (function) – The wrapped function that the wrapper function’s docstring is based on and links to