Skip to content

Commit

Permalink
docs: Add docstrings for Identifier, Properties, RecursiveDict
Browse files Browse the repository at this point in the history
This allows mkdocstrings to generate hyperlinks
to these types in the documentation.

Fixes: #1529
  • Loading branch information
rodrigc committed Jan 16, 2025
1 parent e8e2c91 commit f3bd4a6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pyiceberg/typedef.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,14 @@ def __missing__(self, key: K) -> V:


Identifier = Tuple[str, ...]
"""Type for identifiers in PyIceberg."""

Properties = Dict[str, Any]
"""A dictionary type for properties in PyIceberg."""


RecursiveDict = Dict[str, Union[str, "RecursiveDict"]]
"""A recursive dictionary type for nested structures in PyIceberg."""

# Represents the literal value
L = TypeVar("L", str, bool, int, float, bytes, UUID, Decimal, covariant=True)
Expand Down

0 comments on commit f3bd4a6

Please sign in to comment.