From 55850f26f120e92442b4203c04b2f4f78ddfb185 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Nov 02 2016 16:51:38 +0000
Subject: Document the regex a little more to try to make it more comprehensible


---

diff --git a/pagure/pfmarkdown.py b/pagure/pfmarkdown.py
index 4fd7f5e..dc8323f 100644
--- a/pagure/pfmarkdown.py
+++ b/pagure/pfmarkdown.py
@@ -31,12 +31,12 @@ import pagure.lib
 
 
 MENTION_RE = r'@(\w+)'
-EXPLICIT_LINK_RE = r'(?<!\w)'\
-'(fork[s]?/)?'\
-'([a-zA-Z0-9_-]*?/)?'\
-'([a-zA-Z0-9_-]*?/)?'\
-'([a-zA-Z0-9_-]+)'\
-'#(?P<id>[0-9]+)'
+EXPLICIT_LINK_RE = r'(?<!\w)'\  # Ensure we catch the motif from the start
+'(fork[s]?/)?'\  # See if there is a `forks/` at the start
+'([a-zA-Z0-9_-]*?/)?'\ # See if we have a `user/`
+'([a-zA-Z0-9_-]*?/)?'\  # See if we have a `namespace/`
+'([a-zA-Z0-9_-]+)'\  # Get the last part `project`
+'#(?P<id>[0-9]+)'  # Get the identifier `#<id>`
 IMPLICIT_ISSUE_RE = r'[^|\w](?<!\w)#([0-9]+)'
 IMPLICIT_PR_RE = r'[^|\w](?<!\w)PR#([0-9]+)'
 STRIKE_THROUGH_RE = r'~~(\w+)~~'