digest: improve documentation and test examples in readme
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- markdown, rust
- Ambito
- documentation, testing-qa
Direzione di ricerca
Confronta il README di hashes, il README di digest e la documentazione a livello di crate dell'implementazione hash per identificare esempi e documentazione duplicati. Inizia verificando come il contenuto del README viene incluso nella documentazione di digest e come le dev-dependencies influiscono sul ciclo digest �← sha2 �← digest proposto. Il lavoro è completato quando esiste una documentazione unificata con test di esempio hash funzionanti, referenziati in modo coerente in queste posizioni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Lack of readme example tests has caused #1072.
Also we probably should unify documentation from the hashes and digest' readmes. I think of having most of docs in the digest's readme, which will be included into digest's docs, and we will reference those examples from the hashes readme and hash implementation crate-level docs.
Including working hash tests into digest's docs will cause a weird dependency cycle digest <- sha2 <- digest, but I think it should work since sha2 and other crates will be dev-dependencies.
- Lingua principale
- Rust
- Stelle
- 756
- Fork
- 256
- Merge medio
- 1h 27m
- PR unite (30g)
- 2
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di RustCrypto/traits
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 52/100
RustCrypto/traits#2487 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
RustCrypto/traits#2482 · 5 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 32/100
RustCrypto/traits#2478 · 5 commenti ·
-
cipher
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
RustCrypto/traits#2424 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
RustCrypto/traits#2401 ·
Tutte le issue di RustCrypto/traits
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
bug core
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
-
JIT-compiled number -> Decimal conversion silently overflows instead of raising DECIMAL_OVERFLOW Apertafuzz
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
ClickHouse/ClickHouse#122114 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
linebender/vello_svg#90 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100