h3 icon indicating copy to clipboard operation
h3 copied to clipboard

Document all the public API

Open seanmonstar opened this issue 4 years ago • 1 comments

We should add #![deny(missing_docs)] to the top of the h3 crate, and document all the types and methods that the lint catches.

seanmonstar avatar Dec 22 '20 01:12 seanmonstar

We should also use this opportunity to reorder the modules so they are similar to h2 and hyper:

use std::*;

use external_crate::*

use crate::*;

/// Doc Foo
struct Foo {}

/// Doc Bar
enum Bar {}

// --- impl Foo
impl Foo {}

impl Baz for Foo {}

// --- impl Bar
impl Bar {}

impl Quux for Bar {}

stammw avatar Nov 30 '21 08:11 stammw

I think this can be closed. Or is something left to document?

Ruben2424 avatar Sep 15 '22 16:09 Ruben2424