FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

Aperta il 19 mar 2024

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

Descrizione

This comes from a developer experience feedback made by a grantee user.

go to github fuel-rs and search for bytes64 you'll get one result then go and search in the docs - no results they're imported from use fuel_types::bytes64 and the proper crate should be imported

Guida contributor

Tech stack
rust
Dominio
documentationdeveloper experience
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
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
basic Rustknowledge of fuel types crate
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
The issue requests adding documentation for the fuel types crate, specifically for types like bytes64. Start by examining the fuel types crate in the fuels rs repository to understand the existing types and their usage. Focus on adding doc comments to public types and functions, and consider creating a short guide or module level documentation. Look at the issue comments for any additional context or specific user feedback. Ensure the docs are consistent with the style used elsewhere in the SDK.