alnzng commented on code in PR #195:
URL: https://github.com/apache/flink-agents/pull/195#discussion_r2374611814
##########
python/flink_agents/integrations/chat_models/anthropic/anthropic_chat_model.py:
##########
@@ -210,6 +210,12 @@ class AnthropicChatModelSetup(BaseChatModelSetup):
Attributes:
----------
+ connection : str
Review Comment:
I’m not a Python expert, so this is more of a curiosity question: is it
considered a best practice or common pattern to repeat inherited attributes in
subclass docstrings?
One potential drawback I see is maintainability: if the parent attribute
docs change, we’d need to update every subclass that repeats them, otherwise
the subclass docs could become stale or misleading.
I understand the intent here is to make the subclass docstring
self-contained so users can see all fields without checking the parent. That
makes sense. But (if I understand correctly) most Python doc generators (e.g.,
Sphinx) can automatically include inherited attributes from the parent class,
so we might get the same clarity without duplicating the docs.
@wenjin272 @Sxnan What are your thoughts?
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
