From bb0dc68e4089140b97e5fbbccd60daf843051f28 Mon Sep 17 00:00:00 2001
From: Lee Dohm <lee@lee-dohm.com>
Date: Wed, 19 Aug 2015 07:48:15 -0700
Subject: [PATCH] :memo: Add docs for Markdown formatting of config
 descriptions

Related to atom/settings-view#635
---
 src/config.coffee | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/config.coffee b/src/config.coffee
index 7c6dc8286..00ebabf58 100644
--- a/src/config.coffee
+++ b/src/config.coffee
@@ -283,6 +283,17 @@ ScopeDescriptor = require './scope-descriptor'
 # __Note__: You should strive to be so clear in your naming of the setting that
 # you do not need to specify a title or description!
 #
+# Descriptions allow a subset of
+# [Markdown formatting](https://help.github.com/articles/github-flavored-markdown/).
+# Specifically, you may use the following in configuration setting descriptions:
+#
+# * **bold** - `**bold**`
+# * *italics* - `*italics*`
+# * [links](https://atom.io) - `[links](https://atom.io)`
+# * `code spans` - `\`code spans\``
+# * line breaks - `line breaks<br/>`
+# * ~~strikethrough~~ - `~~strikethrough~~`
+#
 # ## Best practices
 #
 # * Don't depend on (or write to) configuration keys outside of your keypath.