Skip to content

Commit a4115f1

Browse files
authored
fix: resolve RST docstring formatting warnings in docs build (#77)
Modified the generator to use double newlines instead of single newlines when joining multiple status code documentations, ensuring proper RST block quote separation.
1 parent ae15f37 commit a4115f1

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

exoscale/api/generator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def _status_code_docstring(api_spec, operation, status_code):
8383
)
8484

8585
doc = (
86-
f"dict: {ref['description']}. A dictionnary with the following keys:"
86+
f"dict: {ref['description']}. A dictionary with the following keys:"
8787
+ "\n\n * ".join([""] + list(body.values()))
8888
)
8989
elif "description" in ref:
@@ -104,7 +104,7 @@ def _return_docstring(api_spec, operation):
104104
for status_code in operation["responses"].keys()
105105
]
106106

107-
return "\n ".join(status_codes_docs)
107+
return "\n\n ".join(status_codes_docs)
108108

109109

110110
class BaseClient:

0 commit comments

Comments
 (0)