Skip to content

Commit 08033d0

Browse files
committed
Improve doc-strings
1 parent 3a672a1 commit 08033d0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

python/markupever/dom.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -915,10 +915,22 @@ def mathml_annotation_xml_integration_point(self, value: bool) -> None:
915915

916916
@property
917917
def id(self) -> typing.Optional[str]:
918+
"""
919+
Returns the `id` attribute of the element as `str`.
920+
921+
Important note: this property is read-only. use self.attrs to modify it if you want.
922+
"""
923+
# TODO: make this property writable.
918924
return self._raw.id()
919925

920926
@property
921927
def class_list(self) -> typing.List[str]:
928+
"""
929+
Returns the `class` attribute of the element as `list[str]`.
930+
931+
Important note: this property is read-only. use self.attrs to modify it if you want.
932+
"""
933+
# TODO: Return a ElementClassList type instead of list[str] to have better control.
922934
return self._raw.class_list()
923935

924936
def create_doctype(

0 commit comments

Comments
 (0)