Skip to content

Commit

Permalink
Fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
nadove-ucsc committed Jan 10, 2025
1 parent 6f6d52f commit d5c8415
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions src/azul/plugins/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -452,18 +452,17 @@ def verbatim_pfb_schema(self,
replicas: list[JSON]
) -> list[JSON]:
"""
Generate a PFB schema for the verbatim manifest. The default,
metadata-agnostic implementation loads all replica documents into memory
and dynamically generates a schema based on their observed shapes. This
results in inconsistencies in the schema depending on the manifest
contents, so subclasses should override this method if their metadata
adheres to an authoritative schema that can be known in advance.
Generate the azul-specific parts of the PFB schema for the verbatim
manifest. The default, metadata-agnostic implementation loads all
replica documents into memory and dynamically generates a schema based
on their observed shapes. This results in inconsistencies in the schema
depending on the manifest contents, so subclasses should override this
method if their metadata adheres to an authoritative schema that can be
known in advance.
:param replicas: The replica documents to be described by the PFB schema
:return: a tuple of
1. the set of entity types defined by the PFB schema
2. a PFB schema describing the provided replicas
:return: a list of PFB entity schemas describing the replicas
"""
from azul.service import (
avro_pfb,
Expand Down

0 comments on commit d5c8415

Please sign in to comment.