Note snake_case state attribute name convention in entity docs (#27287)

https://github.com/home-assistant/home-assistant/pull/26675#discussion_r331763063
pull/27288/head
Ville Skyttä 2019-10-07 18:16:26 +03:00 committed by Paulus Schoutsen
parent f6b8cffeaf
commit 3adac699c7
1 changed files with 4 additions and 2 deletions

View File

@ -148,7 +148,8 @@ class Entity:
def state_attributes(self) -> Optional[Dict[str, Any]]:
"""Return the state attributes.
Implemented by component base class.
Implemented by component base class. Convention for attribute names
is lowercase snake_case.
"""
return None
@ -156,7 +157,8 @@ class Entity:
def device_state_attributes(self) -> Optional[Dict[str, Any]]:
"""Return device specific state attributes.
Implemented by platform classes.
Implemented by platform classes. Convention for attribute names
is lowercase snake_case.
"""
return None