MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-43035: Fix multiline sections in section-based docstrings

Browse Source 
Now when parse docstring we take into account the block type. For OPTIONAL_TYPE sections such as Returns and Yields we don't require additional indent for lines following the summary.

GitOrigin-RevId: 5dd7adf5f9042204a29b731a3a7379cc3c743af9
This commit is contained in:
Irina.Fediaeva
2022-09-19 22:02:59 +00:00
committed by intellij-monorepo-bot
parent 35842c4b3e
commit 4b1eca9771
8 changed files with 61 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/GoogleCodeStyleDocString.java
+1 -3
View File
@@ -150,11 +150,9 @@ public class GoogleCodeStyleDocString extends SectionBasedDocString {
}
if (description != null) {
// parse line with indentation at least one space greater than indentation of the field
final Pair<List<Substring>, Integer> pair = parseIndentedBlock(lineNum + 1, getLineIndentSize(lineNum));
final Pair<List<Substring>, Integer> pair = parseFieldContinuation(lineNum, fieldType);
final List<Substring> nestedBlock = pair.getFirst();
if (!nestedBlock.isEmpty()) {
//noinspection ConstantConditions
description = description.union(ContainerUtil.getLastItem(nestedBlock));
}
description = description.trim();
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/NumpyDocString.java
+1 -1
View File
@@ -140,7 +140,7 @@ public class NumpyDocString extends SectionBasedDocString {
if (namesPart == null && !isValidType(type.toString())) {
return Pair.create(null, lineNum);
}
final Pair<List<Substring>, Integer> parsedDescription = parseIndentedBlock(lineNum + 1, getLineIndentSize(lineNum));
final Pair<List<Substring>, Integer> parsedDescription = parseFieldContinuation(lineNum, kind);
final List<Substring> descriptionLines = parsedDescription.getFirst();
if (!descriptionLines.isEmpty()) {
description = descriptionLines.get(0).union(descriptionLines.get(descriptionLines.size() - 1));
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
+9
View File
@@ -30,6 +30,8 @@ import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.regex.Pattern;
import static com.jetbrains.python.documentation.docstrings.SectionBasedDocString.FieldType.OPTIONAL_TYPE;
/**
* Common base class for docstring styles supported by Napoleon Sphinx extension.
*
@@ -221,6 +223,13 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
isSectionStart(lineNum);
}
@NotNull
protected Pair<List<Substring>, Integer> parseFieldContinuation(int lineNum, @NotNull FieldType fieldType) {
int indent = getLineIndentSize(lineNum);
// we don't need additional indentation for Yields and Returns sections
return parseIndentedBlock(lineNum + 1, fieldType == OPTIONAL_TYPE ? indent - 1 : indent);
}
/**
* Consumes all lines that are indented more than {@code blockIndent} and don't contain start of a new section.
* Trailing empty lines (e.g. due to indentation of closing triple quotes) are omitted in result.
python/testData/quickdoc/MultilineReturnSectionGoogle.html
+7
View File
@@ -0,0 +1,7 @@
<html><body><div class='definition'><pre><a href="psi_element://#module#MultilineReturnSectionGoogle">MultilineReturnSectionGoogle</a><br>def <b>foo</b>() -&gt; <a href="psi_element://#typename#bool">bool</a></pre></div><div class='content'>Unittest placeholder</div><table class='sections'><tr><td valign='top' class='section'><p>Returns:</td><td valign='top'>True if successful, False otherwise.
The return type is optional and may be specified at the beginning of
the Returns section followed by a colon.
The Returns section may span multiple lines and paragraphs.
Following lines should be indented to match the first line.</td></table></body></html>
python/testData/quickdoc/MultilineReturnSectionGoogle.py
+12
View File
@@ -0,0 +1,12 @@
def fo<the_ref>o():
"""
Returns:
bool: True if successful, False otherwise.
The return type is optional and may be specified at the beginning of
the Returns section followed by a colon.
The Returns section may span multiple lines and paragraphs.
Following lines should be indented to match the first line.
"""
pass
python/testData/quickdoc/MultilineReturnSectionNumpy.html
+7
View File
@@ -0,0 +1,7 @@
<html><body><div class='definition'><pre><a href="psi_element://#module#MultilineReturnSectionNumpy">MultilineReturnSectionNumpy</a><br>def <b>foo</b>() -&gt; <a href="psi_element://#typename#bool">bool</a></pre></div><div class='content'>Unittest placeholder</div><table class='sections'><tr><td valign='top' class='section'><p>Returns:</td><td valign='top'>True if successful, False otherwise.
The return type is optional and may be specified at the beginning of
the Returns section followed by a colon.
The Returns section may span multiple lines and paragraphs.
Following lines should be indented to match the first line.</td></table></body></html>
python/testData/quickdoc/MultilineReturnSectionNumpy.py
+14
View File
@@ -0,0 +1,14 @@
def fo<the_ref>o():
"""
Returns
-------
bool
True if successful, False otherwise.
The return type is optional and may be specified at the beginning of
the Returns section followed by a colon.
The Returns section may span multiple lines and paragraphs.
Following lines should be indented to match the first line.
"""
pass
python/testSrc/com/jetbrains/python/PyQuickDocTest.java
+10
View File
@@ -721,6 +721,16 @@ public class PyQuickDocTest extends LightMarkedTestCase {
checkHTMLOnly();
}
// PY-43035
public void testMultilineReturnSectionGoogle() {
checkHTMLOnly();
}
// PY-43035
public void testMultilineReturnSectionNumpy() {
checkHTMLOnly();
}
@Override
protected String getTestDataPath() {
return super.getTestDataPath() + "/quickdoc/";