Skip to content

Commit 0d68505

Browse files
committed
Clearly reflect when RECORD validation methods were added
1 parent 9246b52 commit 0d68505

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/installer/sources.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,13 @@ class WheelSource:
2323
This is an abstract class, whose methods have to be implemented by subclasses.
2424
"""
2525

26-
validation_error: ClassVar[Type[Exception]] = ValueError
26+
validation_error: ClassVar[Type[Exception]] = ValueError #: :meta hide-value:
27+
"""
28+
.. versionadded:: 0.7.0
29+
30+
Exception to be raised by :py:meth:`validate_record` when validation fails.
31+
This is expected to be a subclass of :py:class:`ValueError`.
32+
"""
2733

2834
def __init__(self, distribution: str, version: str) -> None:
2935
"""Initialize a WheelSource object.
@@ -71,6 +77,8 @@ def read_dist_info(self, filename: str) -> str:
7177
def validate_record(self) -> None:
7278
"""Validate ``RECORD`` of the wheel.
7379
80+
.. versionadded:: 0.7.0
81+
7482
This method should be called before :py:func:`install <installer.install>`
7583
if validation is required.
7684
"""

0 commit comments

Comments
 (0)