Skip to content

fix(lsp): update documentation for unwraps #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KyrylR merged 1 commit into from
Mar 13, 2026
Merged

fix(lsp): update documentation for unwraps #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions lsp/src/completion/builtin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ pub fn match_callname(call: &CallName) -> Option<FunctionTemplate> {
Some(FunctionTemplate::new(
"unwrap_left",
vec![format!("{ty}")],
vec![format!("Either<{ty}, U>")],
vec![format!("Either<T, {ty}>")],
ty,
doc,
))
Expand All @@ -53,7 +53,7 @@ pub fn match_callname(call: &CallName) -> Option<FunctionTemplate> {
Some(FunctionTemplate::new(
"unwrap_right",
vec![format!("{ty}")],
vec![format!("Either<T, {ty}>")],
vec![format!("Either<{ty}, U>")],
ty,
doc,
))
Expand Down Expand Up @@ -136,15 +136,17 @@ fn builtin_documentation(call: &CallName) -> String {
"Extracts the left variant of an `Either` value.\n
Returns the left-side value if it exists, otherwise panics.\n
```simplicityhl
let x: Either<u8, u8> = Left(42);
let y: u8 = unwrap_left::<u8>(x); // 42
let x: Either<u8, u32> = Left(42);
// We must specify the type of the right variant so the compiler knows the full type.
let y: u8 = unwrap_left::<u32>(x); // 42
```",
CallName::UnwrapRight(_) =>
"Extracts the right variant of an `Either` value.\n
Returns the right-side value if it exists, otherwise panics.\n
```simplicityhl
let x: Either<u8, u8> = Right(128);
let y: u8 = unwrap_right::<u8>(x); // 128
let x: Either<u8, u32> = Right(128);
// We must specify the type of the left variant so the compiler knows the full type.
let y: u32 = unwrap_right::<u8>(x); // 128
```",
CallName::Unwrap =>
"Unwraps an `Option` value, panicking if it is `None`.\n
Expand Down
Loading