Skip to content

Commit 011a1cc

Browse files
committed
docs: pr feedback
1 parent 62e12eb commit 011a1cc

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/ape/api/convert.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,6 @@ def is_convertible(self, to_type: type) -> bool:
7373
@abstractmethod
7474
def convert_to(self, to_type: type) -> Any:
7575
"""
76-
Convert ``self`` to the given type. Raises ``ConversionError`` if not convertible.
76+
Convert ``self`` to the given type. Implementing classes _should_ raises ``ConversionError`` if not convertible.
77+
Ape's conversion system will **only** attempt to convert classes where ``.is_convertible()`` returns ``True``.
7778
"""

0 commit comments

Comments
 (0)