Update documentation

More precise descriptions of markdown-bold-underscore and markdown-italic-underscore.
jrblevin · Jan 11, 2016 · fc1204b · fc1204b
1 parent a9a5601
commit fc1204b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -450,10 +450,12 @@ provides an interface to all of the possible customizations:
     demotion, keep these sorted from largest to smallest.
 
   * `markdown-bold-underscore` - set to a non-nil value to use two
-    underscores for bold instead of two asterisks (default: `nil`).
+    underscores when inserting bold text instead of two asterisks
+    (default: `nil`).
 
   * `markdown-italic-underscore` - set to a non-nil value to use
-    underscores for italic instead of asterisks (default: `nil`).
+    underscores when inserting italic text instead of asterisks
+    (default: `nil`).
 
   * `markdown-asymmetric-header` - set to a non-nil value to use
     asymmetric header styling, placing header characters only on
@@ -765,7 +767,7 @@ following people:
   * Danny McClanahan for live preview mode,
     completion of GFM programming language names, and `cl-lib` updates.
   * Syohei Yoshida for better heading detection
-    and movement functions.
+    and movement functions, improved italic font lock.
 
 ## Bugs
 

diff --git a/markdown-mode.el b/markdown-mode.el
@@ -502,10 +502,12 @@
 ;;     demotion, keep these sorted from largest to smallest.
 ;;
 ;;   * `markdown-bold-underscore' - set to a non-nil value to use two
-;;     underscores for bold instead of two asterisks (default: `nil').
+;;     underscores when inserting bold text instead of two asterisks
+;;     (default: `nil').
 ;;
 ;;   * `markdown-italic-underscore' - set to a non-nil value to use
-;;     underscores for italic instead of asterisks (default: `nil').
+;;     underscores when inserting italic text instead of asterisks
+;;     (default: `nil').
 ;;
 ;;   * `markdown-asymmetric-header' - set to a non-nil value to use
 ;;     asymmetric header styling, placing header characters only on
@@ -945,12 +947,12 @@ promotion and demotion functions."
   :type 'list)
 
 (defcustom markdown-bold-underscore nil
-  "Use two underscores for bold instead of two asterisks."
+  "Use two underscores when inserting bold text instead of two asterisks."
   :group 'markdown
   :type 'boolean)
 
 (defcustom markdown-italic-underscore nil
-  "Use underscores for italic instead of asterisks."
+  "Use underscores when inserting italic text instead of asterisks."
   :group 'markdown
   :type 'boolean)