Page MenuHomeSoftware Heritage

Updated API Docs to add limit query param
ClosedPublic

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

Diff Detail

Repository
rDGRPH Graph service
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

legau created this revision.Mar 5 2020, 1:14 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
179–181

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

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
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
This revision was automatically updated to reflect the committed changes.