FuelLabs/fuels-rs

add documentation for `decode_as_debug_str`

Open

#1,296 opened on 2024年3月12日

GitHub で見る
 (0 comments) (1 reaction) (0 assignees)Rust (43,211 stars) (1,360 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.