Page MenuHomeSoftware Heritage

Added test only method info in the interface doc strings
Needs ReviewPublic

Authored by jayeshv on Thu, Sep 9, 8:44 AM.

Details

Reviewers
aeviso
douardda
Group Reviewers
Reviewers

Diff Detail

Repository
rDPROV Provenance database
Branch
doc-string-updates
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 23527
Build 36708: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 36707: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D6220 (id=22501)

Rebasing onto 26061a0a15...

Current branch diff-target is up to date.
Changes applied before test
commit 01f5a7421dc417c879182b309971ead591cd75df
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Thu Sep 9 08:42:21 2021 +0200

    Added test only method info in the interface doc strings

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

douardda requested changes to this revision.Thu, Sep 9, 9:02 AM
douardda added a subscriber: douardda.

Please use imperative style in the got commit message
https://chris.beams.io/posts/git-commit/

This revision now requires changes to proceed.Thu, Sep 9, 9:02 AM

Not sure we really want to restrict this methods to test-only in the documentation. But we can change this in the future anyway

Docstring changes for test only methods (Minor).

Added 'used only in tests' information in the doc strings of the storage
interface methods.

Please use imperative style in the got commit message
https://chris.beams.io/posts/git-commit/

done

Build is green

Patch application report for D6220 (id=22592)

Rebasing onto 4c2b0907a9...

Current branch diff-target is up to date.
Changes applied before test
commit 5340af73075eca5b6337aa11ea1276a2eea5b8a2
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Thu Sep 9 08:42:21 2021 +0200

    Docstring changes for test only methods (Minor).
    
    Added 'used only in tests' information in the doc strings of the storage
    interface methods.

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

Not sure we really want to restrict this methods to test-only in the documentation. But we can change this in the future anyway

This lets me forget those methods while doing some performance optimization and test. Sure, we can change this later.