build(docs): add warning for parsing \n in exmaple response

Author: joeperpetua

docs_parser.py

@@ -283,7 +283,15 @@ def gen_method(method: dict, file_content: str) -> str:
         return content + SEPARATOR
 
     description = text(docstring.short_description or '', newline=True)
-    description += text(docstring.long_description or '', newline=True)
+    # In some cases, the whole docstring text will be parsed in the long_description.
+    # Avoid appending it in that case.
+    if isinstance(docstring.long_description, str) and docstring.long_description.find('Parameters') != -1:
+        print(docstring.params)
+        print('========>', docstring.long_description)
+        warnings.warn(f'[{method["name"]}] failed to parse docstrings. Make sure the format is correct. Check guidelines if needed.', UserWarning)
+    else: 
+        description += text(docstring.long_description or '', newline=True)
+        
     description = dedup_newlines(description)
 
     internal_api = parse_method_api(method['name'], file_content)

documentation/docs/contribute/docs_guidelines.md

@@ -45,6 +45,7 @@ We use the [numpy convention](https://numpydoc.readthedocs.io/en/latest/format.h
 - Always use double quotes for the docstrings
 - Always use backticks (`) to display data types or objects, you can use code blocks specifying the language.
 - Don't use HTML tags, or keywords enclosed by gt/lt, instead use backticks.
+- Sometimes, return objects contain strings with `\n` inside of them, please remove them as they may avoid the docstring to be parsed.
 
 #### Information
 - Try to keep the first line of the description brief. You can add more information in new lines.