From 074108d91b827682bf3f99736c78390abcc2d2ac Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Thu, 13 Feb 2020 11:41:02 +0100 Subject: [PATCH] doc(interface-types) Improve documentation of `decoders::binary::leb`. --- src/decoders/binary.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/decoders/binary.rs b/src/decoders/binary.rs index 027e8e5..e0a3fad 100644 --- a/src/decoders/binary.rs +++ b/src/decoders/binary.rs @@ -51,7 +51,9 @@ fn byte<'input, E: ParseError<&'input [u8]>>(input: &'input [u8]) -> IResult<&'i Ok((&input[1..], input[0])) } -/// Parse an unsigned LEB with value no larger than a 64-bits number. +/// Parse an unsigned Little Endian Based (LEB) with value no larger +/// than a 64-bits number. Read +/// [LEB128](https://en.wikipedia.org/wiki/LEB128) to learn more. fn leb<'input, E: ParseError<&'input [u8]>>(input: &'input [u8]) -> IResult<&'input [u8], u64, E> { if input.is_empty() { return Err(Err::Error(make_error(input, ErrorKind::Eof)));