Add documentation for HTTPS remote regex

gizmo385 · Jan 29, 2025 · 7f3f89d · 7f3f89d
1 parent a906e86
commit 7f3f89d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lazy_github/lib/git_cli.py b/lazy_github/lib/git_cli.py
@@ -10,6 +10,11 @@
 # "([^.]+)"     Match everything until the period, which should be the repo name
 # ".git"        Match the .git suffix
 _SSH_GIT_REMOTE_REGEX = re.compile(r".+:([^\/]+)\/([^.]+)(?:.git)?")
+
+# Regex designed to match something like "https://github.com/gizmo385/gh-lazy.git"
+# "^https:\/\/[^.]+[^\/]+"  Match the base URL until the first non-prefix slash (eg: https://github.com)
+# "([^\/]+)"                Match the username (eg: gizmo385)
+# "([^\/]+)$"               Match the end of the URL (eg: gh-lazy.git)
 _HTTPS_GIT_REMOTE_REGEX = re.compile(r"^https:\/\/[^.]+[^\/]+\/([^\/]+)\/([^\/]+)$")