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

PY-21883: PR remarks. Show elements from 'Other Parameters' inside 'Parameters' section in Numpy docstrings

Browse Source 
Removed redundant keyword arguments in parameters section, cosmetics.

GitOrigin-RevId: 213132671cc844eb31a168c4e8a17af169d1aac2
This commit is contained in:
Irina.Fediaeva
2022-08-24 17:22:24 +03:00
committed by intellij-monorepo-bot
parent 680913f146
commit 2c35b284f9
4 changed files with 3 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
View File

@@ -368,7 +368,6 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
final List<Section> parameters = new ArrayList<>();
parameters.addAll(getSectionsWithNormalizedTitle(PARAMETERS_SECTION));
parameters.addAll(getSectionsWithNormalizedTitle(OTHER_PARAMETERS_SECTION));
parameters.addAll(getSectionsWithNormalizedTitle(KEYWORD_ARGUMENTS_SECTION));
return parameters;
}

10
python/testData/docstrings/googleCombinesParameterSections.py
View File

@@ -1,10 +0,0 @@
def func(param1):
"""
Args:
x:
y:
Keyword Args:
z:
"""
pass

2
python/testData/docstrings/numpyCombinesParameterSections.py → python/testData/docstrings/numpyCombinesParamsAndOtherParamsSections.py
View File

@@ -1,4 +1,4 @@
def func(param1):
def func(x, y, z):
"""
Parameters
----------

13
python/testSrc/com/jetbrains/python/PySectionBasedDocStringTest.java
View File

@@ -235,11 +235,10 @@ public class PySectionBasedDocStringTest extends PyTestCase {
"Line after single break", param1.getDescription());
}
public void testNumpyCombinesParameterSections() {
// PY-21883
public void testNumpyCombinesParamsAndOtherParamsSections() {
final NumpyDocString docString = findAndParseNumpyStyleDocString();
final List<String> parameters = docString.getParameters();
assertEquals(List.of("x", "y", "z"), parameters);
}
@@ -428,14 +427,6 @@ public class PySectionBasedDocStringTest extends PyTestCase {
assertEquals("return value description", docString.getReturnDescription());
}
public void testGoogleCombinesParameterSections() {
final GoogleCodeStyleDocString docString = findAndParseGoogleStyleDocString();
final List<String> parameters = docString.getParameters();
assertEquals(List.of("x", "y", "z"), parameters);
}
@Override
protected String getTestDataPath() {
return super.getTestDataPath() + "/docstrings";