Ticket #218: bad-docString.patch

Source/CobraParser.cobra

@@ -2049 +2065 @@
                     s.afterParserRecognizesStatement
                     if .optional('COMMA')
                         s = .multiTargetAssign(s to Expr)
-        if expectEOL
-            if .verbosity>=5
-                print '<> last statement start token=[token]'
-                print '<> s = [s]'
-            try
-                .expect('EOL')
-            catch pe as ParserException
-                # example: puts 5
-                token = .last(1)
-                if token <> nil
-                    sugg = if(token.text.length, Compiler.suggestionFor(token.text), nil)
-                    sugg = if(sugg, ' Try "[sugg]" instead of "[token.text]".', nil)
-                    if sugg, pe = pe.cloneWithMessage(pe.message + sugg)
-                throw pe
+        if expectEOL, _handleStmtEOL(token, s)
         _finishSpaceAgnostic
         return s
-
-
+        
+    def _handleStmtEOL(token as IToken?, s as Stmt?)
+        if .verbosity>=5
+            print '<> last statement start token=[token]'
+            print '<> s = [s]'
+        try
+            .expect('EOL')
+        catch pe as ParserException
+            # example: puts 5
+            token = .last(1)
+            if token <> nil
+                print token, .last
+                sugg = if(token.text.length, Compiler.suggestionFor(token.text), nil)
+                sugg = if(sugg, ' Try "[sugg]" instead of "[token.text]".', nil)
+                if sugg == nil and .last.which == 'DOUBLE_QUOTE' and token.which =='STRING_DOUBLE'
+                    l2 = 'A docString needs to be either entirely on a single line or have its start and end triple quotes alone on a separate line before and after the docString text.'
+                    sugg = '\nThis looks like the start of a docString but it wasnt recognised.\n[l2]'
+                if sugg, pe = pe.cloneWithMessage(pe.message + sugg)
+            throw pe
+        
     ##
     ## Individual Statements
     ##

Tests/820-errors/100-lexing-and-parsing/404-doc-string.cobra

@@ +1 @@
+# .error. This looks like the start of a docString but it wasnt recognised.
+# on line 9 
+class Program
+
+    def main
+        pass
+        
+    def m1  # below docstring is invalid, need leading/trailing delim alone on own lines
+        """ This docString causes
+            indigestion. """
+        pass

Tests/820-errors/100-lexing-and-parsing/406-doc-string.cobra

@@ +1 @@
+class Program
+
+    def main
+        pass
+
+    def m1 # below docstring is invalid, need leading/trailing delim alone on own lines
+        """ 
+            This one also causes
+            it indigestion. """
+        pass
+# .error. Expecting more doc string contents or the end of the doc string instead of "DEDENT".

Developer/IntermediateReleaseNotes.text

@@ -475 +475 @@
 * Fixed: Dynamic binding cannot find `shared` methods.  ticket:208
 
 * Fixed: File and line number are duplicated in some compiler error messages.  ticket:212
+
+* Fixed: Better error message for unrecognised docString : ticket:218