FuelLabs/fuels-rs

add documentation for `decode_as_debug_str`

Open

#1 296 ouverte le 12 mars 2024

Voir sur GitHub
 (0 commentaires) (1 réaction) (0 assignés)Rust (1 360 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (43 211 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la PR #1291 pour comprendre l'implémentation de `decode as debug str`. Ensuite, localisez les fichiers de documentation pertinents (par exemple dans le livre ou la documentation API) et ajoutez une description claire de l'utilisation de cette fonction, incluant des exemples de code.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80