Skip to content

Commit 9f87311

Browse files
committed
docs(CHANGES): Note pip and base urls for git parser
1 parent 555ae5c commit 9f87311

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

CHANGES

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ $ pip install --user --upgrade --pre libvcs
1515

1616
### What's new
1717

18-
- **Parser**: Experimental VCS URL parsing added ({issue}`376`, {issue}`381`):
18+
- **Parser**: Experimental VCS URL parsing added ({issue}`376`, {issue}`381`, {i}): {issue}`384`):
1919

2020
VCS Parsers return {func}`dataclasses.dataclass` instances. The new tools support validation,
2121
parsing, mutating and exporting into URLs consumable by the VCS.
@@ -28,9 +28,16 @@ $ pip install --user --upgrade --pre libvcs
2828

2929
- {mod}`libvcs.parse.git`
3030

31-
- {class}`~libvcs.parse.git.GitURL` - Parse git URLs
32-
- {meth}`~libvcs.parse.git.GitURL.is_valid`
33-
- {meth}`~libvcs.parse.git.GitURL.to_url` - export `git clone`-compatible URL
31+
- {class}`~libvcs.parse.git.GitBaseURL` - Parse git URLs, `git(1)` compatible
32+
33+
- {meth}`~libvcs.parse.git.GitBaseURL.is_valid`
34+
- {meth}`~libvcs.parse.git.GitBaseURL.to_url` - export `git clone`-compatible URL
35+
36+
- {class}`~libvcs.parse.git.GitPipURL` - Pip URLs, {meth}`~libvcs.parse.git.GitPipURL.is_valid`,
37+
{meth}`~libvcs.parse.git.GitPipURL.to_url`
38+
39+
- {class}`~libvcs.parse.git.GitURL` - Compatibility focused,
40+
{meth}`~libvcs.parse.git.GitURL.is_valid` {meth}`~libvcs.parse.git.GitURL.to_url`
3441

3542
- {mod}`libvcs.parse.hg`
3643

0 commit comments

Comments
 (0)