FuelLabs/fuels-rs

add documentation for `decode_as_debug_str`

Open

Aperta il 12 mar 2024

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Rust (43.211 star) (1360 fork)batch import
documentationgood first issue

Descrizione

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.

Guida contributor

Tech stack
rust
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
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.