Page MenuHomeSoftware Heritage
Differential D7942

Improve doc strings and inline documentation
ClosedPublic
Actions

Authored by jayeshv on Jun 1 2022, 5:51 PM.

Details

Reviewers
vlorentz
ardumont
Group Reviewers
Reviewers
Maniphest Tasks
T4261: Swh-graphql Code cleanup
Commits
rDGQL267732ffffef: Improve doc strings and inline documentation
Summary

Related to T4261

Diff Detail

Repository
rDGQL GraphQL API
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

jayeshv created this revision.Jun 1 2022, 5:51 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptJun 1 2022, 5:51 PM
swh-public-ci added a comment.Jun 1 2022, 5:54 PM

Build is green

Patch application report for D7942 (id=28603)

Rebasing onto c8ef46e760...

Current branch diff-target is up to date.
Changes applied before test
commit 8accb28a366248fc8741d7d8d1127182573091fa
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Tue May 31 14:04:50 2022 +0200

    Improve doc strings and inline documentation
    
    Related to T4261

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

Harbormaster completed remote builds in B29685: Diff 28603.Jun 1 2022, 5:54 PM
jayeshv requested review of this revision.Jun 1 2022, 5:54 PM
jayeshv updated this revision to Diff 28604.Jun 1 2022, 6:00 PM

format changes

swh-public-ci added a comment.Jun 1 2022, 6:02 PM

Build is green

Patch application report for D7942 (id=28604)

Rebasing onto c8ef46e760...

Current branch diff-target is up to date.
Changes applied before test
commit 93ceb8cb3deb9f0ead66b9111a79eb35fbed1cc6
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Tue May 31 14:04:50 2022 +0200

    Improve doc strings and inline documentation
    
    Related to T4261

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

Harbormaster completed remote builds in B29686: Diff 28604.Jun 1 2022, 6:02 PM
vlorentz requested changes to this revision.Jun 1 2022, 6:22 PM
vlorentz added a subscriber: vlorentz.

some comments below for the first files in the diff, but they apply to others too

swh/graphql/resolvers/content.py
54–55

redundant

swh/graphql/resolvers/directory.py
51

add a type annotation instead

51

s/required/requested/ ?

61–62

ditto

swh/graphql/resolvers/directory_entry.py
31

would an annotation work here too?

swh/graphql/resolvers/resolvers.py
11
This revision now requires changes to proceed.Jun 1 2022, 6:22 PM
jayeshv updated this revision to Diff 28605.Jun 1 2022, 9:07 PM

review comments

swh-public-ci added a comment.Jun 1 2022, 9:10 PM

Build is green

Patch application report for D7942 (id=28605)

Rebasing onto c8ef46e760...

Current branch diff-target is up to date.
Changes applied before test
commit 418b121b4d5aa34b745c1e523bb6eb0a128bb829
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Tue May 31 14:04:50 2022 +0200

    Improve doc strings and inline documentation
    
    Add type hints for parent objects in a resolver
    
    Related to T4261

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

Harbormaster completed remote builds in B29688: Diff 28605.Jun 1 2022, 9:10 PM
jayeshv updated this revision to Diff 28606.Jun 1 2022, 9:11 PM
jayeshv marked 5 inline comments as done.

Type hint update

jayeshv marked an inline comment as done.Jun 1 2022, 9:13 PM
swh-public-ci added a comment.Jun 1 2022, 9:13 PM

Build is green

Patch application report for D7942 (id=28606)

Rebasing onto c8ef46e760...

Current branch diff-target is up to date.
Changes applied before test
commit f00e0fd49273095c9576d42b8c11122ead974e1b
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Tue May 31 14:04:50 2022 +0200

    Improve doc strings and inline documentation
    
    Add type hints for parent objects in a resolver
    
    Related to T4261

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

Harbormaster completed remote builds in B29689: Diff 28606.Jun 1 2022, 9:13 PM
ardumont accepted this revision.Jun 2 2022, 1:02 PM
vlorentz accepted this revision.Jun 2 2022, 3:45 PM
vlorentz added inline comments.
swh/graphql/resolvers/directory.py
61–62

I still feel "obj.targetHash is the requested directory id" is redundant when the next line clearly gets a directory with that id

swh/graphql/resolvers/directory_entry.py
31

you can remove the comment now

This revision is now accepted and ready to land.Jun 2 2022, 3:45 PM
jayeshv updated this revision to Diff 28622.Jun 2 2022, 3:55 PM

Remove unnecessary comments

swh-public-ci added a comment.Jun 2 2022, 3:57 PM

Build is green

Patch application report for D7942 (id=28622)

Rebasing onto c8ef46e760...

Current branch diff-target is up to date.
Changes applied before test
commit 267732ffffefbc569fcc31af04c9825b60bf3ff3
Author: Jayesh Velayudhan <jayesh@softwareheritage.org>
Date:   Tue May 31 14:04:50 2022 +0200

    Improve doc strings and inline documentation
    
    Add type hints for parent objects in a resolver
    
    Related to T4261

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

Harbormaster completed remote builds in B29705: Diff 28622.Jun 2 2022, 3:57 PM
Closed by commit rDGQL267732ffffef: Improve doc strings and inline documentation (authored by jayeshv). · Explain WhyJun 2 2022, 3:58 PM
This revision was automatically updated to reflect the committed changes.
jayeshv added a commit: rDGQL267732ffffef: Improve doc strings and inline documentation.

Revision Contents
Changeset List

PathSize
swh/
graphql/
resolvers/
2 lines
6 lines
31 lines
37 lines
19 lines
8 lines
24 lines
12 lines
45 lines
24 lines
31 lines
26 lines
17 lines
tests/
4 lines

Diff 28624

View Options

swh/graphql/resolvers/base_connection.py

Loading...
View Options

swh/graphql/resolvers/base_node.py

Loading...
View Options

swh/graphql/resolvers/content.py

Loading...
View Options

swh/graphql/resolvers/directory.py

Loading...
View Options

swh/graphql/resolvers/directory_entry.py

Loading...
View Options

swh/graphql/resolvers/origin.py

Loading...
View Options

swh/graphql/resolvers/release.py

Loading...
View Options

swh/graphql/resolvers/resolvers.py

Loading...
View Options

swh/graphql/resolvers/revision.py

Loading...
View Options

swh/graphql/resolvers/snapshot.py

Loading...
View Options

swh/graphql/resolvers/snapshot_branch.py

Loading...
View Options

swh/graphql/resolvers/visit.py

Loading...
View Options

swh/graphql/resolvers/visit_status.py

Loading...
View Options

swh/graphql/tests/data.py

Loading...
About · Developer information · Legal