class_docstr: Represents a set of parameter documents in the docstring.
class_docstr_tok: ["Represents","a","set","of","parameter","documents","in","the","docstring","."]
docstr: Formats placeholders in `docstring`.
  
  Examples
  --------
  >>> pd = ParamDocs(p1="doc1", p2="doc2
  doc2 second line")
  >>> docstring = '''
  ... :param p1: {{ p1 }}
  ... :param p2: {{ p2 }}
  ... '''.strip()
  >>> print(pd.format_docstring(docstring))
  :param p1: doc1
  :param p2: doc2
             doc2 second line
  
  Args:
      p1: {{ p1 }}
      p2: {{ p2 }}
docstr_tok: ["Formats","placeholders","in","`","docstring","`",".","Examples","--","--","--","--",">",">",">","pd","=","ParamDocs","(","p1=","''","doc1","''",",","p2=","''","doc2","doc2","second","line","''",")",">",">",">","docstring","=","``","'","...",":","param","p1",":","{","{","p1","}","}","...",":","param","p2",":","{","{","p2","}","}","...","``","'.strip","(",")",">",">",">","print","(","pd.format_docstring","(","docstring",")",")",":","param","p1",":","doc1",":","param","p2",":","doc2","doc2","second","line","Args",":","p1",":","{","{","p1","}","}","p2",":","{","{","p2","}","}"]
code: def format_docstring(self, docstring: str) -> str:
      """
      Formats placeholders in `docstring`.
  
      Examples
      --------
      >>> pd = ParamDocs(p1="doc1", p2="doc2
      doc2 second line")
      >>> docstring = '''
      ... :param p1: {{ p1 }}
      ... :param p2: {{ p2 }}
      ... '''.strip()
      >>> print(pd.format_docstring(docstring))
      :param p1: doc1
      :param p2: doc2
                 doc2 second line
  
      Args:
          p1: {{ p1 }}
          p2: {{ p2 }}
  
      """
      if docstring is None:
          return None
  
      replacements = _replace_keys_with_placeholders(self)
      lines = docstring.splitlines()
      for i, line in enumerate(lines):
          lines[i] = _replace_all(line, replacements)
  
      return "\n".join(lines)
  
imports: import textwrap
  import warnings
  from functools import wraps
  from typing import Dict
  import importlib_metadata
  from packaging.version import Version
  from mlflow.ml_package_versions import _ML_PACKAGE_VERSIONS
  from mlflow.utils.autologging_utils.versioning import FLAVOR_TO_MODULE_NAME_AND_VERSION_INFO_KEY
label_desc: Use image node_id 3 for calling the ParamDocs obj's underlying member method code with example usage: obj.format_docstring(docstring) and returns: str, None