sfackler / rust-native-tls

Apache License 2.0
473 stars 197 forks source link

Update builders documentation #271

Closed rust1248 closed 1 year ago

rust1248 commented 1 year ago

Fixes #266

Update the Builders documentation to make clearer how to construct them

sfackler commented 1 year ago

There are some rustfmt failures.

rust1248 commented 1 year ago

These are not mine (I only updated the docs)

sfackler commented 1 year ago

The rustfmt failures are pointing at the docs you updated:

 }

 /// A builder for `TlsConnector`s.
-/// 
+///
 /// You can get one from [`TlsConnector::builder()`](TlsConnector::builder)
 pub struct TlsConnectorBuilder {
     identity: Option<Identity>,
Diff in /home/runner/work/rust-native-tls/rust-native-tls/src/lib.rs at line 5[19](https://github.com/sfackler/rust-native-tls/actions/runs/5342182950/jobs/9726590832?pr=271#step:4:21):
 }

 /// A builder for `TlsAcceptor`s.
-/// 
+///
 /// You can get one from [`TlsAcceptor::builder()`](TlsAcceptor::builder)
 pub struct TlsAcceptorBuilder {
     identity: Identity,
rust1248 commented 1 year ago

@sfackler Sorry for that, I only saw the other error

I fixed them (I think)