milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve module docs 

Improve the module rustdocs for `bip158` by doing:

- Add bip references
- Use correct markdown headings
- Use caps in title
This commit is contained in:
Tobin C. Harding 2022-08-09 14:50:41 +10:00
parent 25d1472924
commit f6105a16a7
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/util/bip158.rs
View File

@ -5,14 +5,19 @@
// on 11. June 2019 which is licensed under Apache, that file specifically // on 11. June 2019 which is licensed under Apache, that file specifically
// was written entirely by Tamas Blummer, who is re-licensing its contents here as CC0. // was written entirely by Tamas Blummer, who is re-licensing its contents here as CC0.
//! BIP158 Compact Block Filters for light clients. //! BIP 158 Compact Block Filters for Light Clients.
//! //!
//! This module implements a structure for compact filters on block data, for //! This module implements a structure for compact filters on block data, for
//! use in the BIP 157 light client protocol. The filter construction proposed //! use in the BIP 157 light client protocol. The filter construction proposed
//! is an alternative to Bloom filters, as used in BIP 37, that minimizes filter //! is an alternative to Bloom filters, as used in BIP 37, that minimizes filter
//! size by using Golomb-Rice coding for compression. //! size by using Golomb-Rice coding for compression.
//! //!
//! ## Example //! ### Relevant BIPS
//!
//! * [BIP 157 - Client Side Block Filtering](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki)
//! * [BIP 158 - Compact Block Filters for Light Clients](https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki)
//!
//! # Examples
//! //!
//! ```ignore //! ```ignore
//! fn get_script_for_coin(coin: &OutPoint) -> Result<Script, BlockFilterError> { //! fn get_script_for_coin(coin: &OutPoint) -> Result<Script, BlockFilterError> {