We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
Docstring.source
1 parent c1290e7 commit bff6f61Copy full SHA for bff6f61
1 file changed
src/griffe/_internal/models.py
@@ -137,6 +137,14 @@ def lines(self) -> list[str]:
137
def source(self) -> str:
138
"""The original, uncleaned value of the docstring as written in the source.
139
140
+ It is a simple concatenation of the source lines. These source lines will include
141
+ quotes (single/double/triple) and might include leading whitespace and indentation,
142
+ as well as trailing comments.
143
+
144
+ Raises:
145
+ ValueError: If the original docstring cannot be retrieved
146
+ (no parent, no line numbers, or attached to namespace package).
147
148
See also: [`value`][griffe.Docstring.value].
149
"""
150
if self.parent is None:
0 commit comments