From e9bac975186a7d3bbad19ecf2a0d72b3bc26b7fc Mon Sep 17 00:00:00 2001
From: Paul <pfultz2@yahoo.com>
Date: Tue, 7 Feb 2017 17:09:39 -0600
Subject: [PATCH] Add a reference to the XRefRole class

---
 recommonmark/parser.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/recommonmark/parser.py b/recommonmark/parser.py
index d5b715d..44ca20b 100644
--- a/recommonmark/parser.py
+++ b/recommonmark/parser.py
@@ -227,7 +227,9 @@ def inline_entity(inline):
     entity_node = nodes.paragraph('', val, format='html')
     return entity_node
 
-
+# The goal is to make references work like the `:any:` role except when an url
+# is given. See the XRefRole class in sphinx:
+# https://github.com/sphinx-doc/sphinx/blob/master/sphinx/roles.py
 def make_refnode(label, target, has_explicit_title):
     if target and target.startswith(('http://', 'https://')):
         ref_node = nodes.reference()