forked from realpython/materials
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocstring_2.py
More file actions
71 lines (53 loc) · 1.12 KB
/
docstring_2.py
File metadata and controls
71 lines (53 loc) · 1.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
"""Propmt
Write a Google-style docstring for the following function:
def add(a, b):
return a + b
"""
# Output:
def add(a, b):
"""Sum two numbers.
Args:
a (int or float): The first number.
b (int or float): The second number.
Returns:
int or float: The sum of the two numbers.
"""
return a + b
"""Prompt
Write a Numpy-style docstring for the following function:
def add(a, b):
return a + b
"""
# Output:
def add_(a, b):
"""
Sum two numbers.
Parameters
----------
a : int or float
The first number to be added.
b : int or float
The second number to be added.
Returns
-------
int or float
The sum of a and b.
"""
return a + b
"""Prompt
Write a Sphinx-style docstring for the following function:
def add(a, b):
return a + b
"""
# Output:
def add__(a, b):
"""
Calculate the sum of two numbers.
:param a: The first number.
:type a: int or float
:param b: The second number.
:type b: int or float
:return: The sum of the two numbers.
:rtype: int or float
"""
return a + b