From 6d3d0a4be2e3bc75972d23f01247282b3f9b6acd Mon Sep 17 00:00:00 2001
From: Mikhail Golubev <mikhail.golubev@jetbrains.com>
Date: Thu, 24 Sep 2015 19:00:38 +0300
Subject: [PATCH] PY-16771 Never return null as description in section based
 docstrings

---
 .../src/com/jetbrains/python/psi/StructuredDocString.java      | 1 +
 .../python/documentation/docstrings/EpydocString.java          | 1 +
 .../python/documentation/docstrings/PlainDocString.java        | 1 +
 .../python/documentation/docstrings/SectionBasedDocString.java | 3 ++-
 .../python/documentation/docstrings/SphinxDocString.java       | 1 +
 .../python/documentation/docstrings/TagBasedDocString.java     | 1 +
 6 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java b/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
index 3e701cec9900..3ffc323479cd 100644
--- a/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
+++ b/python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java
@@ -27,6 +27,7 @@ import java.util.List;
 public interface StructuredDocString {
 
   String getSummary();
+  @NotNull
   String getDescription(); // for formatter
 
   @NotNull
diff --git a/python/src/com/jetbrains/python/documentation/docstrings/EpydocString.java b/python/src/com/jetbrains/python/documentation/docstrings/EpydocString.java
index 25fb496e9139..f2110768371d 100644
--- a/python/src/com/jetbrains/python/documentation/docstrings/EpydocString.java
+++ b/python/src/com/jetbrains/python/documentation/docstrings/EpydocString.java
@@ -50,6 +50,7 @@ public class EpydocString extends TagBasedDocString {
     super(docstringText, "@");
   }
 
+  @NotNull
   @Override
   public String getDescription() {
     final String html = inlineMarkupToHTML(myDescription);
diff --git a/python/src/com/jetbrains/python/documentation/docstrings/PlainDocString.java b/python/src/com/jetbrains/python/documentation/docstrings/PlainDocString.java
index e023000dbaf2..169427608f20 100644
--- a/python/src/com/jetbrains/python/documentation/docstrings/PlainDocString.java
+++ b/python/src/com/jetbrains/python/documentation/docstrings/PlainDocString.java
@@ -57,6 +57,7 @@ public class PlainDocString extends DocStringLineParser implements StructuredDoc
     return mySummary;
   }
 
+  @NotNull
   @Override
   public String getDescription() {
     return myDescription;
diff --git a/python/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java b/python/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
index 7e6e8efd171d..2a678c468b03 100644
--- a/python/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
+++ b/python/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
@@ -299,9 +299,10 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
     return mySummary != null ? mySummary.concatTrimmedLines("\n") : "";
   }
 
+  @NotNull
   @Override
   public String getDescription() {
-    return null;
+    return "";
   }
 
   @NotNull
diff --git a/python/src/com/jetbrains/python/documentation/docstrings/SphinxDocString.java b/python/src/com/jetbrains/python/documentation/docstrings/SphinxDocString.java
index 5f850863cdc1..37f2d2cbcfdf 100644
--- a/python/src/com/jetbrains/python/documentation/docstrings/SphinxDocString.java
+++ b/python/src/com/jetbrains/python/documentation/docstrings/SphinxDocString.java
@@ -123,6 +123,7 @@ public class SphinxDocString extends TagBasedDocString {
     return paramName == null ? getTagValue("type") : getTagValue("type", paramName);
   }
 
+  @NotNull
   @Override
   public String getDescription() {
     return myDescription.replaceAll("\n", "<br/>");
diff --git a/python/src/com/jetbrains/python/documentation/docstrings/TagBasedDocString.java b/python/src/com/jetbrains/python/documentation/docstrings/TagBasedDocString.java
index 745c4f2a953e..2c17f050fa7d 100644
--- a/python/src/com/jetbrains/python/documentation/docstrings/TagBasedDocString.java
+++ b/python/src/com/jetbrains/python/documentation/docstrings/TagBasedDocString.java
@@ -74,6 +74,7 @@ public abstract class TagBasedDocString extends DocStringLineParser implements S
 
   public abstract List<String> getAdditionalTags();
 
+  @NotNull
   @Override
   public String getDescription() {
     return myDescription;