Skip to content

Commit 555ae5c

Browse files
committed
docs(GitURL): Note ancestors
1 parent 4262739 commit 555ae5c

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

libvcs/parse/git.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,18 @@ def to_url(self) -> str:
405405

406406
@dataclasses.dataclass(repr=False)
407407
class GitURL(GitPipURL, GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
408-
"""Batteries included URL Parser. Supports git(1) and pip URLs."""
408+
"""Batteries included URL Parser. Supports git(1) and pip URLs.
409+
410+
**Ancestors (MRO)**
411+
This URL parser inherits methods and attributes from the following parsers:
412+
413+
- :class:`GitPipURL`
414+
415+
- :meth:`GitPipURL.to_url`
416+
- :class:`GitBaseURL`
417+
418+
- :meth:`GitBaseURL.to_url`
419+
"""
409420

410421
matchers = MatcherRegistry = MatcherRegistry(
411422
_matchers={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}

0 commit comments

Comments
 (0)