Bläddra i källkod

docs(horizontalRule): Change horizontalRule documentation (#606)

Fix horizontalRule documentation to reflect its actual purpose
Vladimir Vuksanovic 6 år sedan
förälder
incheckning
fc1717780e
1 ändrade filer med 4 tillägg och 1 borttagningar
  1. 4 1
      src/subParsers/makehtml/horizontalRule.js

+ 4 - 1
src/subParsers/makehtml/horizontalRule.js

@@ -1,5 +1,8 @@
 /**
- * Turn Markdown link shortcuts into XHTML <a> tags.
+ * Turn Markdown horizontal rule shortcuts into <hr /> tags.
+ *
+ * Any 3 or more unindented consecutive hyphens, asterisks or underscores with or without a space beetween them
+ * in a single line is considered a horizontal rule
  */
 showdown.subParser('makehtml.horizontalRule', function (text, options, globals) {
   'use strict';