Skip to content

Commit 404522c

Browse files
author
John Lyu
committed
fix docstring of method
1 parent 92d721a commit 404522c

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

ariadne_codegen/client_generators/custom_fields.py

+15-6
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def _generate_class_def_body(
142142
name=class_name, base_names=base_names, description=description
143143
)
144144
lineno = 0
145-
for org_name, field in self._get_combined_fields(definition).items():
145+
for org_name, field in self._get_combined_fields(definition).items():
146146
lineno += 1
147147
name = process_name(
148148
org_name, convert_to_snake_case=self.convert_to_snake_case
@@ -158,12 +158,13 @@ def _generate_class_def_body(
158158
name, field_name, org_name, field, method_required, lineno
159159
)
160160
)
161-
if field.description:
161+
if field.description and not method_required:
162162
lineno += 1
163-
docstring = ast.Expr(value=ast.Constant(field.description), lineno=lineno)
163+
docstring = ast.Expr(
164+
value=ast.Constant(field.description), lineno=lineno
165+
)
164166
class_def.body.append(docstring)
165167

166-
167168
class_def.body.append(
168169
self._generate_fields_method(
169170
class_name, definition.name, sorted(additional_fields_typing)
@@ -225,7 +226,10 @@ def _generate_class_field(
225226
"""Handles the generation of field types."""
226227
if getattr(field, "args") or method_required:
227228
return self.generate_product_type_method(
228-
name, field_name, getattr(field, "args")
229+
name,
230+
field_name,
231+
getattr(field, "args"),
232+
description=getattr(field, "description"),
229233
)
230234
return generate_ann_assign(
231235
target=generate_name(name),
@@ -320,7 +324,11 @@ def _generate_on_method(self, class_name: str) -> ast.FunctionDef:
320324
)
321325

322326
def generate_product_type_method(
323-
self, name: str, class_name: str, arguments: Optional[Dict[str, Any]] = None
327+
self,
328+
name: str,
329+
class_name: str,
330+
arguments: Optional[Dict[str, Any]] = None,
331+
description: Optional[str] = None,
324332
) -> ast.FunctionDef:
325333
"""Generates a method for a product type."""
326334
arguments = arguments or {}
@@ -360,6 +368,7 @@ def generate_product_type_method(
360368
),
361369
return_type=generate_name(f'"{class_name}"'),
362370
decorator_list=[generate_name("classmethod")],
371+
description=description,
363372
)
364373

365374
def _get_suffix(

0 commit comments

Comments
 (0)