From 2889bd83dbc2fd9fe00f6384c448a6c75b290fda Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Tue, 23 Aug 2022 14:48:04 +0800
Subject: [PATCH] updated example

---
 examples/how_to_write_docstring.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/examples/how_to_write_docstring.py b/examples/how_to_write_docstring.py
index 3228de5..be57e9b 100644
--- 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)
-- 
GitLab