PY-17470 PY-17529 Don't attempt to remove quotes from already unescaped docstring
authorMikhail Golubev <mikhail.golubev@jetbrains.com>
Fri, 6 Nov 2015 10:55:57 +0000 (13:55 +0300)
committerMikhail Golubev <mikhail.golubev@jetbrains.com>
Fri, 6 Nov 2015 13:16:11 +0000 (16:16 +0300)
Because PyStringLiteralExpressionImpl#getNodeTextRange used for that
strips at least first character unconditionally, user sees corrupted
docstring description without the first letter.

python/src/com/jetbrains/python/documentation/docstrings/PyStructuredDocstringFormatter.java

index 975b936904f0816657058c12a2d869ad3b881730..645dbe9aee0316bbbb6177be9d3aa15d1f26697b 100644 (file)
@@ -71,20 +71,20 @@ public class PyStructuredDocstringFormatter {
     final DocStringFormat format = DocStringUtil.guessDocStringFormat(preparedDocstring, element);
     if (format == DocStringFormat.GOOGLE) {
       formatter = PythonHelper.GOOGLE_FORMATTER;
-      structuredDocString = DocStringUtil.parseDocString(DocStringFormat.GOOGLE, preparedDocstring);
+      structuredDocString = DocStringUtil.parseDocStringContent(DocStringFormat.GOOGLE, preparedDocstring);
     }
     else if (format == DocStringFormat.NUMPY) {
       formatter = PythonHelper.NUMPY_FORMATTER;
-      structuredDocString = DocStringUtil.parseDocString(DocStringFormat.NUMPY, preparedDocstring);
+      structuredDocString = DocStringUtil.parseDocStringContent(DocStringFormat.NUMPY, preparedDocstring);
     }
     else if (format == DocStringFormat.EPYTEXT) {
       formatter = PythonHelper.EPYDOC_FORMATTER;
-      structuredDocString = DocStringUtil.parseDocString(DocStringFormat.EPYTEXT, preparedDocstring);
+      structuredDocString = DocStringUtil.parseDocStringContent(DocStringFormat.EPYTEXT, preparedDocstring);
       result.add(formatStructuredDocString(structuredDocString));
     }
     else if (format == DocStringFormat.REST) {
       formatter = PythonHelper.REST_FORMATTER;
-      structuredDocString = DocStringUtil.parseDocString(DocStringFormat.REST, preparedDocstring);
+      structuredDocString = DocStringUtil.parseDocStringContent(DocStringFormat.REST, preparedDocstring);
     }
 
     else {