class_docstr: Substitution docstring placeholders.
  
  A decorator to take a function's docstring and perform string
  substitution on it.
  
  This decorator should be robust even if func.__doc__ is None
  (for example, if -OO was passed to the interpreter)
  
  Usage: construct a docstring.Substitution with a dictionary suitable
  for performing substitution; then decorate a suitable function with
  the constructed object. e.g.
  
  sub_author_name = Substitution(author='Jason')
  
  @sub_author_name
  def some_function(x):
      "{author} wrote this function"
  
  # note that some_function.__doc__ is now "Jason wrote this function"
class_docstr_tok: ["Substitution","docstring","placeholders",".","A","decorator","to","take","a","function","'s","docstring","and","perform","string","substitution","on","it",".","This","decorator","should","be","robust","even","if","func.__doc__","is","None","(","for","example",",","if","-OO","was","passed","to","the","interpreter",")","Usage",":","construct","a","docstring.Substitution","with","a","dictionary","suitable","for","performing","substitution",";","then","decorate","a","suitable","function","with","the","constructed","object",".","e.g",".","sub_author_name","=","Substitution","(","author='Jason","'",")","@","sub_author_name","def","some_function","(","x",")",":","``","{","author","}","wrote","this","function","''","#","note","that","some_function.__doc__","is","now","``","Jason","wrote","this","function","''"]
docstr: Update self.params with supplied args.
docstr_tok: ["Update","self.params","with","supplied","args","."]
code: def update(self, **kwargs) -> None:
      """Update self.params with supplied args."""
      if isinstance(self.params, dict):
          self.params.update(
              {
                  k: DocStr(v) if not isinstance(v, DocStr) else v
                  for k, v in kwargs.items()
              }
          )
  
file_path: deepchecks/deepchecks/utils/decorators.py
imports: import textwrap
  import typing
  from functools import wraps
  from deepchecks.utils.logger import get_logger
label_desc: Use image node_id 3 for calling the Substitution obj's underlying member method code with example usage: obj.update() without return types