Page MenuHomeSoftware Heritage

Add missing documentation for `get_metadata_authority`.
ClosedPublic

Authored by vlorentz on Nov 4 2021, 11:44 AM.

Diff Detail

Repository
rDLDBASE Generic VCS/Package Loader
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build is green

Patch application report for D6605 (id=23996)

Could not rebase; Attempt merge onto 5063082e7d...

Updating 5063082..01e47b9
Fast-forward
 docs/package-loader-tutorial.rst                 | 25 ++++++++++++++++++++
 swh/loader/package/deposit/loader.py             |  5 ----
 swh/loader/package/deposit/tests/test_deposit.py | 30 +++++++++++++++++++++++-
 3 files changed, 54 insertions(+), 6 deletions(-)
Changes applied before test
commit 01e47b9075492bb5bb6906378c27dd19433a056c
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 4 11:43:53 2021 +0100

    Add missing documentation for `get_metadata_authority`.

commit 8ab9ae38ac44b216c1c86a0d53c018a1c4d7a02a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Oct 21 14:35:47 2021 +0200

    deposit: Remove 'parent' deposit
    
    The parent is computed by the deposit as the revision of the latest deposit
    in the same origin before the current one.
    Therefore, it is redundant, as it can be recomputed from metadata
    + revision date.
    
    This is a preliminary change needed to make package loaders produce
    releases instead of revisions, as releases don't have parent relationships

See https://jenkins.softwareheritage.org/job/DLDBASE/job/tests-on-diff/591/ for more details.

Build is green

Patch application report for D6605 (id=23997)

Rebasing onto 5063082e7d...

Current branch diff-target is up to date.
Changes applied before test
commit 18bbbae719fc9d165d5b543e54d449f5befc083a
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Thu Nov 4 11:43:53 2021 +0100

    Add missing documentation for `get_metadata_authority`.

See https://jenkins.softwareheritage.org/job/DLDBASE/job/tests-on-diff/592/ for more details.

olasd added a subscriber: olasd.

Maybe it would be worth making the second example the default implementation for this function?

This revision is now accepted and ready to land.Nov 4 2021, 5:59 PM

I would rather keep it explicit, it's too easy to overlook it otherwise.