delete_params

DocstringProcessor.delete_params(base_key, *params)[source]

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 the 'Parameters' sections.

The new docstring without the selected parts will be accessible as base_key + '.no_' + '|'.join(params), e.g. 'original_key.no_param1|param2'.

See the keep_params() method for an example.

Parameters
  • base_key (str) – key in the params dictionary

  • *params – str. Parameter identifier of which the documentations shall be deleted