The arti-client `experimental-api` feature doesn't cascade to other crates, resulting in confusing docs
You might see this:
and from that and the arti_client
documentation, reasonably conclude that what you need to do is enable the experimental-api
feature on arti-client
. But you'd be wrong!
Rustdoc is actually misleading here and that yellow label is referring to the (identically-named) feature on the tor-proto
crate! So either
- the
experimental-api
feature onarti-client
should set it on all dependencies that have that feature, or - we should do some form of mitigation to make the docs less confusing.
(I was about to just send in an MR to implement the first option, but that might actually be inadvisable; perhaps we want users to realise that they're opting into each crate's experimental features? Or maybe not; what do people think?)