FuelLabs / FuelLabs/sway

Read doc comments from call paths

Open
#3,985 0 comments 0 reactions 0 assignees View on GitHub
language server
Dominant language
Rust
Stars
61.4k
Forks
5.4k
Avg merge
3h 33m
Merged PRs (30d)
4

Description

Since #3971 we now have go-to definition support for call paths which is great. However, it seems that doc comments aren't displayed on hover requests for these tokens yet in the language server.

We should write tests against [this example](https://github.com/FuelLabs/sway/blob/master/sway-lsp/test/fixtures/tokens/paths/src/main.sw) to ensure doc comments are a handled for these tokens.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the call-path example in sway-lsp/test/fixtures/tokens/paths/src/main.sw and inspect the language server's hover handling for those tokens. Add coverage showing that their doc comments appear in hover responses, then run the relevant language-server tests to verify the behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.