FuelLabs/fuels-rs

add documentation for `decode_as_debug_str`

Open

#1296 opened on Mar 12, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Rust (43,211 stars) (1,360 forks)batch import
documentationgood first issue

Description

The PR https://github.com/FuelLabs/fuels-rs/pull/1291 introduced a new function to decode debug strings using paramtypes and encoded data. The documentation should be updated to explain how users can use it.

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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review PR #1291 to understand the implementation of `decode as debug str`. Then locate the relevant documentation files (e.g., in the book or API docs) and add a clear description of how to use this function, including code examples.