Page MenuHomeSoftware Heritage

Fix/update docstrings of build_swh_revision.
ClosedPublic

Authored by vlorentz on Mar 16 2021, 11:54 AM.

Details

Summary

They were wrong/misleading:

  • 'rev' is an int, not a dict
  • 'commit' is the data, not metadata in the SWH sense

Diff Detail

Repository
rDLDSVN Subversion (SVN) 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 D5255 (id=18839)

Rebasing onto fc530fb14f...

Current branch diff-target is up to date.
Changes applied before test
commit a129049d5314db553ddce4489c218db17c574960
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Mar 16 11:54:23 2021 +0100

    Fix/update docstrings of build_swh_revision.
    
    They were wrong/misleading:
    
    * 'rev' is an int, not a dict
    * 'commit' is the data, not metadata in the SWH sense

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

Build is green

Patch application report for D5255 (id=18840)

Rebasing onto fc530fb14f...

Current branch diff-target is up to date.
Changes applied before test
commit e66eea6d3daa05b9824fd0df1f7e2042083b7653
Author: Valentin Lorentz <vlorentz@softwareheritage.org>
Date:   Tue Mar 16 11:54:23 2021 +0100

    Fix/update docstrings of build_swh_revision.
    
    They were wrong/misleading:
    
    * 'rev' is an int, not a dict
    * 'commit' is the data, not metadata in the SWH sense

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

anlambert added a subscriber: anlambert.
anlambert added inline comments.
swh/loader/svn/converters.py
52–56

You can remove the leading - to match other docstring formats.

This revision is now accepted and ready to land.Mar 16 2021, 12:02 PM