File: models.md

package info (click to toggle)
python-griffe 1.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,092 kB
  • sloc: python: 14,305; javascript: 84; makefile: 41; sh: 23
file content (73 lines) | stat: -rw-r--r-- 1,183 bytes parent folder | download
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
# Docstring models

## **Main API**

::: griffe.Docstring

## **Advanced API: Sections**

::: griffe.DocstringSectionKind

::: griffe.DocstringSectionText

::: griffe.DocstringSectionParameters

::: griffe.DocstringSectionOtherParameters

::: griffe.DocstringSectionRaises

::: griffe.DocstringSectionWarns

::: griffe.DocstringSectionReturns

::: griffe.DocstringSectionYields

::: griffe.DocstringSectionReceives

::: griffe.DocstringSectionExamples

::: griffe.DocstringSectionAttributes

::: griffe.DocstringSectionFunctions

::: griffe.DocstringSectionClasses

::: griffe.DocstringSectionModules

::: griffe.DocstringSectionDeprecated

::: griffe.DocstringSectionAdmonition

## **Advanced API: Section items**

::: griffe.DocstringAdmonition

::: griffe.DocstringDeprecated

::: griffe.DocstringRaise

::: griffe.DocstringWarn

::: griffe.DocstringReturn

::: griffe.DocstringYield

::: griffe.DocstringReceive

::: griffe.DocstringParameter

::: griffe.DocstringAttribute

::: griffe.DocstringFunction

::: griffe.DocstringClass

::: griffe.DocstringModule

## **Models base classes**

::: griffe.DocstringElement

::: griffe.DocstringNamedElement

::: griffe.DocstringSection