Skip to content

Commit

Permalink
Update README.md with RepairKit summary
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdunnjpl authored Dec 6, 2023
1 parent 419321d commit d0e60bc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ This package provides supplementary metadata generation for registry documents,

### Components

#### [RepairKit](https://github.com/NASA-PDS/registry-sweepers/blob/main/src/pds/registrysweepers/repairkit/__init__.py)
The repairkit sweeper applies idempotent transformations to targeted subsets of properties, for example ensuring that all properties expected to have array-like values are in fact arrays (as opposed to single-element arrays being flattened to strings during harvest). Documents are processed based on whether their `ops:Provenance/ops:registry_sweepers_repairkit_version` is up-to-date relative to the sweeper codebase.

#### [Provenance](https://github.com/NASA-PDS/registry-sweepers/blob/main/src/pds/registrysweepers/provenance.py)
The provenance sweeper generates metadata for linking each version-superseded product with the versioned product which supersedes it. The value of the successor is stored in the `ops:Provenance/ops:superseded_by` property. This property will not be set for the latest version of any product.

Expand Down

0 comments on commit d0e60bc

Please sign in to comment.