sphinx-doc.el icon indicating copy to clipboard operation
sphinx-doc.el copied to clipboard

Feature request: "warning" and "note"

Open ChenSun-Phys opened this issue 1 year ago • 0 comments

It would be nice to have functions that automatically generate a skeleton for 'warning' and 'note'. For example:

    def function(array, key):
        """
        This function does ...

        .. warning::

            Possible warnings tba. 

        Docstring continued...

        .. note::

            The syntax should be ... 

        Parameters
        ----------
        value : list
            Array read from the parameter file
        key : str
            Name of the parameter

        """

ChenSun-Phys avatar Mar 31 '23 20:03 ChenSun-Phys