updated example

2889bd83 · BO ZHANG · 0184c5ce · 2889bd83
Commit 2889bd83 authored 2 years ago by BO ZHANG
Show whitespace changes
Inline Side-by-side

Showing

with 4 additions and 0 deletions
+4 -0
--- a/examples/how_to_write_docstring.py
+++ b/examples/how_to_write_docstring.py
@@ -30,5 +30,9 @@ def cos(x: float = 0.):
    --------
    >>> import numpy as np
    >>> cos(np.pi)
+
+    Notes
+    -----
+    this function is a warpper of `numpy.cos()`
    """
    return np.cos(x)