Skip to content

Commit 24ee80a

Browse files
update
1 parent 566c333 commit 24ee80a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

frictionless/metadata/metadata.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ class Metadata:
6161
"""
6262
List of custom parameters. Any extra property will be added
6363
to the custom property.
64+
65+
A "custom" property is an additional property to the one expected by the
66+
classes "profile" (See the "metadata_profile_*" properties)
6467
"""
6568

6669
def __new__(cls, *args: Any, **kwargs: Any):
@@ -368,6 +371,7 @@ def to_markdown(self, path: Optional[str] = None, table: bool = False) -> str:
368371
"""
369372

370373
metadata_initiated: bool = False
374+
"""Is set to true when the class initialization is finished"""
371375

372376
metadata_assigned: Set[str] = set()
373377
"""Set of all names of properties to which a value (different from None)
@@ -410,6 +414,12 @@ def metadata_select_class(cls, type: Optional[str]) -> Type[Metadata]:
410414

411415
@classmethod
412416
def metadata_select_property_class(cls, name: str) -> Optional[Type[Metadata]]:
417+
"""Defines the class to use with a given property's metadata
418+
419+
Complex properties are likely to have their own python class,
420+
inheriting from Metadata. If this is the case, this method should
421+
return this class when called with the property name as "name".
422+
"""
413423
pass
414424

415425
@classmethod
@@ -567,7 +577,7 @@ def metadata_import(
567577
) -> Self:
568578
"""Deserialization of a descriptor to a class instance
569579
570-
The deserialization and serialization must be lossless
580+
The deserialization and serialization must be lossless.
571581
"""
572582
merged_options = {}
573583
profile = cls.metadata_ensure_profile()

0 commit comments

Comments
 (0)