enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-11-27 16:54:09 +03:00
Code Issues Projects Releases Wiki Activity

Update suggestion argument doc (#3948)

Browse Source 
Updated the doc to match the implemented API.
This commit is contained in:
Dmitry Bushev 2022-12-05 16:29:18 +03:00 committed by GitHub
parent a24dfe6adb
commit 768747a55e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/language-server/protocol-language-server.md
View File

@ -428,16 +428,18 @@ The argument of a [`SuggestionEntry`](#suggestionentry).
```typescript
// The argument of a constructor, method or function suggestion.
interface SuggestionEntryArgument {
// The argument name
/** The argument name. */
name: string;
// The argument type. String 'Any' is used to specify generic types
/** The argument type. String 'Any' is used to specify generic types. */
type: string;
// Indicates whether the argument is lazy
/** Indicates whether the argument is lazy. */
isSuspended: bool;
// Indicates whether the argument has default value
/** Indicates whether the argument has default value. */
hasDefault: bool;
// Optional default value
/** Optional default value. */
defaultValue?: string;
/** Optional list of possible values that this argument takes. */
tagValues?: string[];
}
```

3
engine/polyglot-api/src/main/scala/org/enso/polyglot/Suggestion.scala
View File

@ -142,6 +142,7 @@ object Suggestion {
* @param isSuspended is the argument lazy
* @param hasDefault does the argument have a default
* @param defaultValue optional default value
* @param tagValues optional list of possible values
*/
case class Argument(
name: String,
@ -160,6 +161,8 @@ object Suggestion {
s"isSuspended=$isSuspended," +
s"hasDefault=$hasDefault,defaultValue=" +
(if (shouldMask) defaultValue.map(_ => STUB) else defaultValue) +
s",tagValues=" +
(if (shouldMask) tagValues.map(_ => STUB) else tagValues) +
")"
}