Page MenuHomeSoftware Heritage
Differential D2770

Updated API Docs to add limit query param
ClosedPublic
Actions

Authored by legau on Mar 5 2020, 1:14 PM.

Details

Reviewers
zack
Group Reviewers
Reviewers
Commits
rDGRPHfc51feb9d72d: Updated API Docs to add limit query param

Diff Detail

Repository
rDGRPH Compressed graph representation
Branch
docs-update
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 10923
Build 16430: tox-on-jenkinsJenkins
Build 16429: arc lint + arc unit

Event Timeline

legau created this revision.Mar 5 2020, 1:14 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptMar 5 2020, 1:14 PM
swh-public-ci added a comment.Mar 5 2020, 1:16 PM

Build is green
See https://jenkins.softwareheritage.org/job/DGRPH/job/tox/125/ for more details.

Harbormaster completed remote builds in B10922: Diff 9855.Mar 5 2020, 1:16 PM
zack requested changes to this revision.Mar 5 2020, 1:17 PM
zack added a subscriber: zack.
zack added inline comments.
docs/api.rst
178–180

As this is a language-agnostic API, referring Python isn't very helpful here.

Can you rephrase this to say explicitly that positive numbers take the first N elements while negative ones the last N elements?

Other than that this looks good, thanks !

This revision now requires changes to proceed.Mar 5 2020, 1:17 PM
legau updated this revision to Diff 9856.Mar 5 2020, 1:19 PM

Fixed example

swh-public-ci added a comment.Mar 5 2020, 1:21 PM

Build is green
See https://jenkins.softwareheritage.org/job/DGRPH/job/tox/126/ for more details.

Harbormaster completed remote builds in B10923: Diff 9856.Mar 5 2020, 1:21 PM
legau updated this revision to Diff 9857.Mar 5 2020, 1:23 PM

Rephrasing description

legau marked an inline comment as done.Mar 5 2020, 1:23 PM
swh-public-ci added a comment.Mar 5 2020, 1:25 PM

Build is green
See https://jenkins.softwareheritage.org/job/DGRPH/job/tox/127/ for more details.

Harbormaster completed remote builds in B10924: Diff 9857.Mar 5 2020, 1:25 PM
zack accepted this revision.Mar 5 2020, 1:55 PM

perfect, thank you !

This revision is now accepted and ready to land.Mar 5 2020, 1:55 PM
Closed by commit rDGRPHfc51feb9d72d: Updated API Docs to add limit query param (authored by legau). · Explain WhyMar 5 2020, 2:12 PM
This revision was automatically updated to reflect the committed changes.
legau added a commit: rDGRPHfc51feb9d72d: Updated API Docs to add limit query param.

Revision Contents
Changeset List

PathSize
docs/
53 lines

Diff 9856

View Options

docs/api.rst

Loading...
About · Developer information · Legal