tests(create_project): Add example of URL guessing

tony · tony · commit 79d9b010edfa · 2022-09-25T08:22:22.000-05:00
diff --git a/src/libvcs/_internal/shortcuts.py b/src/libvcs/_internal/shortcuts.py
@@ -72,6 +72,17 @@ def create_project(
     ...     dir=tmp_path
     ... )
 
+    >>> isinstance(r, GitSync)
+    True
+
+    create_project can also guess VCS for certain URLs:
+
+    >>> r = create_project(
+    ...     # Note the git+ before the URL
+    ...     url=f'git+file://{create_git_remote_repo()}',
+    ...     dir=tmp_path
+    ... )
+
     >>> isinstance(r, GitSync)
     True
     """
