Page MenuHomeSoftware Heritage

docs/data-model: Update visits chapter definition
ClosedPublic

Authored by ardumont on Apr 1 2020, 4:30 PM.

Details

Summary

(Proposal according to T2310)

Hinting at the origin_visit_update model

Related to T2310

Test Plan

tox

Diff Detail

Repository
rDMOD Data model
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 11582
Build 17559: Phabricator diff pipeline on jenkinsJenkins console · Jenkins
Build 17558: arc lint + arc unit

Event Timeline

Build is green

Patch application report for D2941 (id=10465)

Rebasing onto ca0f6a1eb7...

Current branch diff-target is up to date.
Changes applied before test
commit 182727c506c864c391f5770d42a5cd547fe14d43
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Apr 1 16:28:50 2020 +0200

    docs/data-model: Update visits chapter definition
    
    Hinting at the origin_visit_update model
    
    Related to T2310

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

docs/data-model.rst
146

Those are currently mutable visits and indeed, it's not explicited.
We create the first at the loading time.
And we mutate its state when the loading is done to associate its visit status and snapshot.

vlorentz added a subscriber: vlorentz.

"Every time" means "à chaque fois", it's not about timestamps, so the new phrasing is clunky.

I think you should keep the old phrasing, and add your new sentence. Also mention the name "update" in there.

This revision now requires changes to proceed.Apr 2 2020, 10:48 AM

Build is green

Patch application report for D2941 (id=10471)

Rebasing onto ca0f6a1eb7...

Current branch diff-target is up to date.
Changes applied before test
commit 654c919abecc9b9051b72091ce1cbee448ae4ee6
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Apr 1 16:28:50 2020 +0200

    docs/data-model: Update visits chapter definition
    
    Hinting at the origin_visit_update model
    
    Related to T2310

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

Drop new extra line, keeping the old format

Build is green

Patch application report for D2941 (id=10472)

Rebasing onto ca0f6a1eb7...

Current branch diff-target is up to date.
Changes applied before test
commit 0b4a50ebd9104eda3daa9e5b0157cbabd3c2e3d1
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Apr 1 16:28:50 2020 +0200

    docs/data-model: Update visits chapter definition
    
    Hinting at the origin_visit_update model
    
    Related to T2310

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

This revision is now accepted and ready to land.Apr 2 2020, 11:44 AM
docs/data-model.rst
146

Historically, it got fixed recently [1], some visit updates were done in multiple steps.
It's still in multiple steps but 2 only (1 creation, 1 update).

[1] D2887 D2888 D2889

olasd requested changes to this revision.Apr 2 2020, 12:06 PM
olasd added a subscriber: olasd.

Possessive forms bar's foo are harder to read than their foo of bar counterparts, and should generally be avoided, when bar is an inanimate object.

I propose:

..note::
  This model currently records visits as a single point in time. However, the actual visit process
  is not instantaneous. Loaders can record successive changes to the state of the visit, as their
  work progresses, as updates to the visit object.
This revision now requires changes to proceed.Apr 2 2020, 12:06 PM

Possessive forms bar's foo are harder to read than their foo of bar counterparts, and should generally be avoided, when bar is an inanimate object.

I did not know that.
Thanks.

Build is green

Patch application report for D2941 (id=10490)

Rebasing onto 64a7f620d9...

First, rewinding head to replay your work on top of it...
Applying: docs/data-model: Update visits chapter definition
Changes applied before test
commit e985c2faf5b48715522b5c00af354871116f99eb
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Apr 1 16:28:50 2020 +0200

    docs/data-model: Update visits chapter definition
    
    Hinting at the origin_visit_update model
    
    Related to T2310

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

Build is green

Patch application report for D2941 (id=10491)

Rebasing onto 64a7f620d9...

Current branch diff-target is up to date.
Changes applied before test
commit c7c1a571e5fcd4d7f5431b8dfe0adbd727d28c91
Author: Antoine R. Dumont (@ardumont) <antoine.romain.dumont@gmail.com>
Date:   Wed Apr 1 16:28:50 2020 +0200

    docs/data-model: Update visits chapter definition
    
    Hinting at the origin_visit_update model
    
    Related to T2310

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

This revision is now accepted and ready to land.Apr 2 2020, 6:22 PM