Add missing documentation for sway keywords
Open
Beginner friendly
Nobody has claimed this yet.
compiler: ui
documentation
team:compiler
- Dominant language
- Rust
- Stars
- 61.4k
- Forks
- 5.4k
- Avg merge
- 3h 33m
- Merged PRs (30d)
- 4
Description
since #3792 the language server now shows documentation for sway keywords. The keywords below still need documentation with examples to be added to the sway-lsp/src/utils/keyword_docs.rs file.
-
for -
where -
ref -
script -
contract -
predicate -
library -
dep -
storage -
asm -
deref -
str -
configurable
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open sway-lsp/src/utils/keyword_docs.rs and compare the existing keyword documentation entries to the checklist in this issue. Add documentation and examples for each of the 13 listed Sway keywords, following the file's established style. Done means every checklist item has corresponding documentation for the language server.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100