Skip to content

Commit 1073be9

Browse files
authored
Update README.md
1 parent c1a8a64 commit 1073be9

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

document/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# :memo:文档
2+
1. [项目文档](#1-项目文档"悬停显示")
3+
2. [项目发行文档]("悬停显示")
4+
3. [代码文档]("悬停显示")
25

36
## 1 项目文档
47
API文档适用于项目用户。
@@ -82,7 +85,7 @@ help(square_and_rooter)
8285

8386
注释通常用来解释一小段代码是用干什么的,或者算法的具体。而docstrings更多用来向其他人(或6个月后的你自己)解释代码中特殊函数是怎样使用的或类/函数/模块的用途。
8487

85-
在大或者复杂的项目中,给出更多关于函数或函数干什么的或可能会引起什么异常或返回什么或参数的更多描述,这是很棒的做法。docstrings最流行的风格如[NumPy style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html)
88+
在大或者复杂的项目中,给出更多关于函数或函数干什么的或可能会引起什么异常或返回什么或参数的更多描述,这是很棒的做法。docstrings最流行的风格如[NumPy style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html)
8689
```python
8790
def random_number_generation(arg1, arg2):
8891
"""
@@ -103,4 +106,4 @@ def random_number_generation(arg1, arg2):
103106
Description of return value
104107
"""
105108
return 42
106-
```
109+
```

0 commit comments

Comments
 (0)