FuelLabs/sway

Add inline documentation for `Hasher` type and `Hash` trait

Open

#5091 opened on Sep 5, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
documentationgood first issuelib: std

Description

The Hasher and Hash types should follow the documentation outlined in the SRC-2 standard.

Contributor guide

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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust basicsFamiliarity with Hash/Hasher typesUnderstanding of SRC 2 standard
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requires adding inline documentation to the Hasher type and Hash trait as per the SRC 2 standard. The relevant files are likely in the `sway lib std` directory. No linked PRs or assignees exist, so the issue is available for new contributors. Review the SRC 2 standard for specific documentation requirements.