Skip to content

Commit 9abbb25

Browse files
committed
Fix docstrings for GraphQLErrors
1 parent 72dc035 commit 9abbb25

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

graphql/error/graphql_error.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,16 @@ class GraphQLError(Exception):
3939
"""
4040

4141
path: Optional[List[Union[str, int]]]
42-
"""A list of GraphQL AST Nodes corresponding to this error"""
42+
"""
43+
44+
A list of field names and array indexes describing the JSON-path into the execution
45+
response which corresponds to this error.
46+
47+
Only included for errors during execution.
48+
"""
4349

4450
nodes: Optional[List["Node"]]
45-
"""The source GraphQL document for the first location of this error
46-
47-
Note that if this Error represents more than one node, the source may not represent
48-
nodes after the first node.
49-
"""
51+
"""A list of GraphQL AST Nodes corresponding to this error"""
5052

5153
source: Optional["Source"]
5254
"""The source GraphQL document for the first location of this error

0 commit comments

Comments
 (0)