Clean code comments

This commit is contained in:
Eric Masseran
2025-08-29 18:37:23 +02:00
parent 6e5f201f6c
commit c1e9aee15b

View File

@@ -174,9 +174,6 @@ def get_dataclass_param_names(cls) -> List[DataclassParamName]:
""" """
param_names = [] param_names = []
filter_ = cls.as_context().get_global_filter() filter_ = cls.as_context().get_global_filter()
# .values ordering is not guaranteed, at least not in
# Python < 3.6, when dicts where not ordered, which is an
# implementation detail anyway.
for name in sorted(filter_.values(), key=lambda name: name.start_pos): for name in sorted(filter_.values(), key=lambda name: name.start_pos):
d = name.tree_name.get_definition() d = name.tree_name.get_definition()
annassign = d.children[1] annassign = d.children[1]
@@ -464,13 +461,6 @@ class ClassMixin:
class DataclassParamName(BaseTreeParamName): class DataclassParamName(BaseTreeParamName):
""" """
Represent a field declaration on a class with dataclass semantics. Represent a field declaration on a class with dataclass semantics.
.. code:: python
class A:
a: int
``a`` is a :class:`DataclassParamName`.
""" """
def __init__(self, parent_context, tree_name, annotation_node, default_node): def __init__(self, parent_context, tree_name, annotation_node, default_node):
@@ -547,7 +537,7 @@ class DataclassDecorator(ValueWrapper, FunctionMixin):
class DataclassTransformer(ValueWrapper, ClassMixin): class DataclassTransformer(ValueWrapper, ClassMixin):
""" """
A class with ``dataclass_transform`` applies. dataclass-like semantics will A class decorated with ``dataclass_transform``. dataclass-like semantics will
be assumed for any class that directly or indirectly derives from the be assumed for any class that directly or indirectly derives from the
decorated class or uses the decorated class as a metaclass. Attributes on decorated class or uses the decorated class as a metaclass. Attributes on
the decorated class and its base classes are not considered to be fields. the decorated class and its base classes are not considered to be fields.
@@ -593,11 +583,14 @@ class DataclassWrapper(ValueWrapper, ClassMixin):
.. code:: python .. code:: python
@dataclass class A: ... # this @dataclass
class A: ... # this
@dataclass_transform def create_model(): pass @dataclass_transform
def create_model(): pass
@create_model() class B: ... # or this @create_model()
class B: ... # or this
""" """
def __init__( def __init__(