What is the standard way for writing default values in a python docstring?
<p>I have a function with parameters set to default values.  I'm using a <a href="https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard" rel="nofollow noreferrer">NumPy-style</a> docstring, but I've seen the default values written elsewhere.  What is the commonly accepted placement for writing &quot;default&quot; in the docstring?</p>
<pre><code>def some_func(a_num=None, a_string=None):
    ''' A function that does something special.

    Parameters
    ==========
    a_num : int, default 100                        # is it written here?
        An important number.
    a_string : str, default 'foo'
        A useful string.  Default is 'foo'.         # or here?    
 
    '''
</code></pre>