delete_types#

Docorator.delete_types(base_key, out_key, *types)#

Delete a parameter from a parameter documentation.

This method deletes the given param from the base_key item in the params dictionary and creates a new item with the original documentation without the description of the param. This method works for 'Results' like sections.

See the keep_types() method for an example.

Parameters:

base_key (str) – key in the params dictionary
out_key (str) – Extension for the base key (the final key will be like '%s.%s' % (base_key, out_key)
*types – str. The type identifier of which the documentations shall deleted