From 1a1d68cb74e814c354c840d2966bc796e67ffd09 Mon Sep 17 00:00:00 2001 From: Christoph Hegemann Date: Tue, 30 Jul 2024 06:43:41 +0200 Subject: [PATCH] codeintel: document that pagination for usages might return extra results (#64142) I'm not actually sure if I can even guarantee the _at least_ part for syntactic usages right now. It would require particularily pathological circumstances, but because I have to stay within the given `context.Context` window, I might end up returning fewer syntactic results than requested. I think that should be fixable in the future so I'd still like the spec to reflect the state we'd like to end up at. ## Test plan Just a documentation/specification change --- cmd/frontend/graphqlbackend/codeintel.codenav.graphql | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cmd/frontend/graphqlbackend/codeintel.codenav.graphql b/cmd/frontend/graphqlbackend/codeintel.codenav.graphql index 901ef8f0335..4ced607a00a 100644 --- a/cmd/frontend/graphqlbackend/codeintel.codenav.graphql +++ b/cmd/frontend/graphqlbackend/codeintel.codenav.graphql @@ -485,6 +485,8 @@ extend type Query { When specified, indicates that this request should be paginated and the first N results (relative to the cursor) should be returned. i.e. how many results to return per page. + Will return _at least_ the number of results specified, but may return + more to only return completed files. """ first: Int