Skip to content

docs: add direct URL helper version markers #1331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sapunyangkut wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −3
Draft

docs: add direct URL helper version markers #1331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions src/packaging/direct_url.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,10 @@ def __init__(self, key: str) -> None:

@dataclasses.dataclass(frozen=True, init=False)
class VcsInfo:
"""The version control information of a :class:`DirectUrl`."""
"""The version control information of a :class:`DirectUrl`.

.. versionadded:: 26.1
"""

vcs: str
commit_id: str
Expand Down Expand Up @@ -183,7 +186,10 @@ def _from_dict(cls, d: Mapping[str, Any]) -> Self:

@dataclasses.dataclass(frozen=True, init=False)
class ArchiveInfo:
"""The archive information of a :class:`DirectUrl`."""
"""The archive information of a :class:`DirectUrl`.

.. versionadded:: 26.1
"""

hashes: Mapping[str, str] | None = None

Expand Down Expand Up @@ -231,7 +237,10 @@ def _from_dict(cls, d: Mapping[str, Any]) -> Self:

@dataclasses.dataclass(frozen=True, init=False)
class DirInfo:
"""The local directory information of a :class:`DirectUrl`."""
"""The local directory information of a :class:`DirectUrl`.

.. versionadded:: 26.1
"""

editable: bool | None = None

Expand Down