Skip to content

Commit

Permalink
deny missing docs for git-packetline
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Dec 27, 2020
1 parent 7c623de commit 3a78840
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions git-packetline/src/borrowed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ use quick_error::quick_error;
quick_error! {
/// The error used in [`decode_band()`][Borrowed::decode_band()].
#[derive(Debug)]
#[allow(missing_docs)]
pub enum DecodeBandError {
InvalidSideBand(band: u8) {
display("attempt to decode a non-side channel line or input was malformed: {}", band)
Expand Down
2 changes: 1 addition & 1 deletion git-packetline/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//!
//! For reading the packet line format use the [`Provider`], and for writing the `Writer`.
#![forbid(unsafe_code)]
#![deny(rust_2018_idioms)]
#![deny(rust_2018_idioms, missing_docs)]

pub(crate) const U16_HEX_BYTES: usize = 4;
pub(crate) const MAX_DATA_LEN: usize = 65516;
Expand Down
1 change: 1 addition & 0 deletions git-packetline/src/provider/read.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ impl<'a, T> ReadWithSidebands<'a, T, fn(bool, &[u8])>
where
T: io::Read,
{
/// Create a new instance with the given provider as `parent`.
pub fn new(parent: &'a mut Provider<T>) -> Self {
ReadWithSidebands {
parent,
Expand Down

0 comments on commit 3a78840

Please sign in to comment.