From 3f4423f4306b2eb76f0084b1b4ade06824896bd5 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Tue, 21 Jan 2014 09:10:58 -0800 Subject: [PATCH] Updated Server Client level API (markdown) --- Server-Client-level-API.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Server-Client-level-API.md b/Server-Client-level-API.md index 38788c6..905fda9 100644 --- a/Server-Client-level-API.md +++ b/Server-Client-level-API.md @@ -51,13 +51,13 @@ trait SbtClient extends Closeable { * * @param partialCommand An incomplete command or task string * - * @return A set of "more complete" strings that could be used as sbt commands. - * - * TODO - This should probably return some more structured "completion" thing. - * That would allow us to return examples or types that a client would not use - * in autocomplete... + * @return A set of "completion" strings that could be used as sbt commands. These + * completions are triples of: + * - the string to append + * - the string to display to users + * - a flag? */ - def possibleAutocompletions(partialCommand: String): Future[Set[String]] + def possibleAutocompletions(partialCommand: String, detailLevel: Int): Future[Set[Completion]] /** * This tries to find whether there is a build key associated with the