Include options and error messages in the documentation examples.

Author: gajus

README.md

@@ -476,7 +476,6 @@ This rule takes one argument. If it is `"always"` then a problem is raised when
 The following patterns are considered problems:
 
 ```js
-// Options: ["always"]
 /**
  * Foo.
  *
@@ -486,9 +485,9 @@ The following patterns are considered problems:
 function quux () {
 
 }
+// Options: ["always"]
 // Message: There must be a newline after the description of the JSDoc block.
 
-// Options: ["never"]
 /**
  * Bar.
  *
@@ -499,29 +498,29 @@ function quux () {
 function quux () {
 
 }
+// Options: ["never"]
 // Message: There must be no newline after the description of the JSDoc block.
 ```
 
 The following patterns are not considered problems:
 
 ```js
-// Options: ["always"]
 /**
  * Foo.
  */
 function quux () {
 
 }
+// Options: ["always"]
 
-// Options: ["never"]
 /**
  * Bar.
  */
 function quux () {
 
 }
+// Options: ["never"]
 
-// Options: ["always"]
 /**
  * Foo.
  *
@@ -530,15 +529,16 @@ function quux () {
 function quux () {
 
 }
+// Options: ["always"]
 
-// Options: ["never"]
 /**
  * Bar.
  * @bar
  */
 function quux () {
 
 }
+// Options: ["never"]
 ```
 
 

bin/readme-assertions.js

@@ -9,12 +9,12 @@ import fs from 'fs';
 const formatCodeSnippet = (setup) => {
     const paragraphs = [];
 
+    paragraphs.push(trimCode(setup.code));
+
     if (setup.options) {
         paragraphs.push('// Options: ' + JSON.stringify(setup.options));
     }
 
-    paragraphs.push(trimCode(setup.code));
-
     if (setup.errors) {
         paragraphs.push('// Message: ' + setup.errors[0].message);
     }