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-24854 Allow Quick Documentation invocation when caret is placed inside docstring

Browse Source
This commit is contained in:
Ekaterina Tuzova
2017-09-01 13:30:04 +03:00
parent 048e421e55
commit 99c0e6c3f4
4 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/src/com/jetbrains/python/documentation/PythonDocumentationProvider.java
+4
View File
@@ -566,6 +566,10 @@ public class PythonDocumentationProvider extends AbstractDocumentationProvider i
}
}
}
if (PyTokenTypes.DOCSTRING == elementType) {
final PyDocStringOwner docstringOwner = PsiTreeUtil.getParentOfType(contextElement, PyDocStringOwner.class);
if (docstringOwner != null) return docstringOwner;
}
}
return super.getCustomDocumentationElement(editor, file, contextElement);
}
python/testData/quickdoc/Docstring.html
+1
View File
@@ -0,0 +1 @@
<html><body><code>def <b>foo</b>()<br>Inferred&nbsp;type:&nbsp;()&nbsp;-&gt;&nbsp;None<br><br>Doc&nbsp;of&nbsp;foo.</code></body></html>
python/testData/quickdoc/Docstring.py
+6
View File
@@ -0,0 +1,6 @@
# directly in function
def foo():
"<the_doc>Doc of <the_ref>foo."
pass
foo()
python/testSrc/com/jetbrains/python/PyQuickDocTest.java
+8
View File
@@ -300,6 +300,14 @@ public class PyQuickDocTest extends LightMarkedTestCase {
checkByHTML(myProvider.generateDoc(element, originalElement));
}
public void testDocstring() {
Map<String, PsiElement> marks = loadTest();
final PsiElement originalElement = marks.get("<the_ref>");
final PsiElement element = myProvider.getCustomDocumentationElement(myFixture.getEditor(), myFile, originalElement);
checkByHTML(myProvider.generateDoc(element, originalElement));
}
public void testReferenceToMethodQualifiedWithInstance() {
checkHTMLOnly();
}