FuelLabs/fuels-rs

add documentation for `decode_as_debug_str`

Open

#1,296 建立於 2024年3月12日

在 GitHub 查看
 (0 留言) (1 反應) (0 負責人)Rust (43,211 star) (1,360 fork)batch import
documentationgood first issue

描述

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.

貢獻者指南

技術棧
rust
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.