rodrigc commented on PR #1530:
URL: https://github.com/apache/iceberg-python/pull/1530#issuecomment-2597207467
The issue with the linter is that it does not allow docstrings to appear
after the variable.
For this code:
```
Identifier = Tuple[str, ...]
"""A tuple of strings representing a table identifier.
Each string in the tuple represents a part of the table's unique path. For
example,
a table in a namespace might be identified as:
("namespace", "table_name")
Examples:
>>> identifier: Identifier = ("namespace", "table_name")
"""
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."""
```
The linter fails with:
```
- hook id: check-docstring-first
- exit code: 1
pyiceberg/typedef.py:77: Module docstring appears after code (code seen on
line 17).
```
If I change to:
```
check docstring is
first.................................................Failed
- hook id: check-docstring-first
- exit code: 1
pyiceberg/typedef.py:76: Module docstring appears after code (code seen on
line 17).
```
the linter fails with:
```
check docstring is
first.................................................Failed
- hook id: check-docstring-first
- exit code: 1
pyiceberg/typedef.py:76: Module docstring appears after code (code seen on
line 17).
```
Any ideas as to the best way forward?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org
