FuelLabs/sway

Document the `const` keyword in the Sway Book

Open

#1,892 opened on Jun 7, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
The Sway Bookgood first issue

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 22h 6m) (16 merged PRs in 30d)

Description

const is used in multiple places in the Sway Book but it should have its own section that explains how and where it can be used (e.g. local or global scope) and its limitations (e.g. no const structs yet).

Also, we are now able to use const in more places like constant structs for examples. We should point that out and indicate when const is usable today.

Finally, document when pub is needed. (ref: https://github.com/FuelLabs/sway/pull/2230)

Contributor guide

Research direction
Review the Sway Book for existing `const` usage, examine the referenced PR #2230 for context, and write a new section covering scope, limitations, and pub usage.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
none
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90