softprops / hyperlocal

🔌 ✨rustlang hyper bindings for local unix domain sockets
MIT License
227 stars 46 forks source link

Document that the client/server features are now opt-in #58

Closed edmorley closed 11 months ago

edmorley commented 2 years ago

Adds documentation for the switch to the client and server features now being opt-in, rather than enabled by default (see #54).

I experimented with also enabling the nightly-only doc_cfg / doc_auto_cfg features (that allow showing feature labels in the docs, see rust-lang/rust/issues/43781), however:

So for now it seems best to not use that.

I did adjust the docs.rs config in Cargo.toml to ensure docs are actually generated for all features, since otherwise the docs were almost empty after #54.

I also fixed a few typos / markdown syntax errors (let me know if you'd prefer these in a separate PR).

onalante-msft commented 2 years ago

Sorry this took so long to review. I had this on my to-do and forgot about it.

edmorley commented 2 years ago

@onalante-msft No need to be sorry! Thank you for taking a look :-)

edmorley commented 11 months ago

We've since dropped this as a (transitive) dependency so are no longer using this crate. Closing the PR to clean up my open PRs list.