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-17526 Don't warn about missing *args and **kwargs declarations in "Incorrect Docstring" inspection

Browse Source
This commit is contained in:
Mikhail Golubev
2015-11-11 13:59:44 +03:00
parent b4ca7c6744
commit c7c77f57f2
4 changed files with 13 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/src/com/jetbrains/python/inspections/PyIncorrectDocstringInspection.java
+4 -1
View File
@@ -31,6 +31,8 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static com.jetbrains.python.psi.PyUtil.as;
/**
* @author Mikhail Golubev
* @author Alexey.Ivanov
@@ -88,7 +90,8 @@ public class PyIncorrectDocstringInspection extends PyBaseDocstringInspection {
final List<PyNamedParameter> missing = new ArrayList<PyNamedParameter>();
final List<String> docStringParameters = docString.getParameters();
for (PyParameter p : realParams) {
if (p.isSelf() || !(p instanceof PyNamedParameter)) {
final PyNamedParameter named = as(p, PyNamedParameter.class);
if (p.isSelf() || named == null || named.isPositionalContainer() || named.isKeywordContainer()) {
continue;
}
if (!docStringParameters.contains(p.getName())) {
python/testData/inspections/GoogleDocstringParametersInspection/test.py
+1 -1
View File
@@ -59,7 +59,7 @@ def varagrs_dont_exist():
**<weak_warning descr="Unexpected parameter kwargs in docstring">kwargs</weak_warning>:
"""
def varagrs_undefined(x, <weak_warning descr="Missing parameter args in docstring">*args</weak_warning>, y, <weak_warning descr="Missing parameter kwargs in docstring">**kwargs</weak_warning>):
def varagrs_undefined(x, *args, y, **kwargs):
"""
Args:
x:
python/testData/inspections/PyDocstringParametersInspection/test.py
+8 -1
View File
@@ -41,4 +41,11 @@ def foo(a, <weak_warning descr="Missing parameter c in docstring">c</weak_warnin
@return:
"""
pass
def varargs_undefined(x, *args, y, **kwargs):
"""
@param x:
@param y:
"""
pass
python/testSrc/com/jetbrains/python/PyQuickFixTest.java
-20
View File
@@ -519,26 +519,6 @@ public class PyQuickFixTest extends PyTestCase {
});
}
// PY-16761
public void testGoogleDocStringAddPositionalVararg() {
runWithDocStringFormat(DocStringFormat.GOOGLE, new Runnable() {
@Override
public void run() {
doInspectionTest(PyIncorrectDocstringInspection.class, PyBundle.message("QFIX.docstring.add.$0", "args"), true, true);
}
});
}
// PY-16761
public void testGoogleDocStringAddKeywordVararg() {
runWithDocStringFormat(DocStringFormat.GOOGLE, new Runnable() {
@Override
public void run() {
doInspectionTest(PyIncorrectDocstringInspection.class, PyBundle.message("QFIX.docstring.add.$0", "kwargs"), true, true);
}
});
}
// PY-16908
public void testNumpyDocStringRemoveFirstOfCombinedParams() {
runWithDocStringFormat(DocStringFormat.NUMPY, new Runnable() {