Skip to content

Commit 9cd01b9

Browse files
committed
types(docs): Document RawConfigDict fields
why: RawConfigDict keys render bare in the API reference, while the sibling entry TypedDicts already describe theirs. what: - Add an Attributes section to RawConfigDict - Contrast it with ConfigDict: paths stay as written and shorthand entries are not yet expanded
1 parent bbb01d1 commit 9cd01b9

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

src/vcspull/types.py

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,27 @@ class RepoEntryDict(_RepoEntryDictRequired, _RepoEntryDictOptional):
257257

258258

259259
class RawConfigDict(t.TypedDict):
260-
"""Configuration dictionary without any type marshalling or variable resolution."""
260+
"""Configuration dictionary without any type marshalling or variable resolution.
261+
262+
Counterpart to :class:`ConfigDict` in the shape a config file supplies:
263+
paths stay as written and shorthand entries are not yet expanded.
264+
265+
Attributes
266+
----------
267+
vcs : VCSLiteral
268+
Version control system backing the repository — ``"git"``, ``"hg"``,
269+
or ``"svn"``.
270+
name : str
271+
Repository name, taken from the key it sits under within its
272+
workspace root.
273+
path : StrPath
274+
Checkout location as written, still a :class:`str` or
275+
:class:`os.PathLike` carrying any ``~`` or environment variable.
276+
url : str
277+
VCS URL in vcspull format, e.g. ``git+git@github.com:user/repo.git``.
278+
remotes : GitSyncRemoteDict
279+
Extra git remotes to keep in sync, keyed by remote name.
280+
"""
261281

262282
vcs: VCSLiteral
263283
name: str

0 commit comments

Comments
 (0)