autoDocstring/src/docstring_parts.ts at 973fb880a86f4839fc3acf164009cbf2c39c9bcc · NilsJPWerner/autoDocstring · GitHub

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
export interface DocstringParts {
    name: string;
    decorators: Decorator[];
    args: Argument[];
    kwargs: KeywordArgument[];
    exceptions: Exception[];
    returns: Returns;
    yields: Yields;
    classes: Method[];
    methods: Method[];
    attributes: Attribute[];
}

export interface Decorator {
    name: string;
}

export interface Argument {
    var: string;
    type: string;
}

export interface KeywordArgument {
    default: string;
    var: string;
    type: string;
}

export interface Exception {
    type: string;
}

export interface Returns {
    type: string;
}

export interface Yields {
    type: string;
}

// export interface Class {
//     name: string;
// }

export interface Method {
    name: string;
}

export interface Attribute {
    var: string;
    type: string;
}