example.mod_a
[docs]
module
example.mod_a
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
72
73
74
75
76 | """Module A."""
from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import Iterable
from .sub.mod_b import ClassB
class ClassA:
attr_a: str = "string"
"""Attribute A."""
def __init__(self, a: str):
"""Class A.
Args:
a: A string.
"""
self.attr_a = a
def method_a(self, x: Iterable[str], y: ClassB) -> ClassA:
"""Method A. Return `ClassA`.
Args:
x: An iterable of strings.
y: An instance of `ClassB`.
Returns:
An instance of `ClassA`.
"""
if not x:
raise ValueError
return self
def func_a(x: int) -> int:
"""Function A.
Args:
x: An integer.
Returns:
An integer.
See Also:
- `ClassA.method_a`
- `ClassB.method_b`
- [`func_b`][example.sub.mod_b.func_b]
"""
return 2 * x
def sum_and_product(x, y):
"""Computes the sum and product of two integers
Parameters
----------
x : int
y : int
Returns
-------
s : int
sum of x and y
p : int
product of x and y
"""
return x+y, x*y
|