Commit 45a56e2
authored
docs(iroh-net): Document cargo features needed for APIs (#2759)
## Description
This uses the feature of docs.rs to enable showing which cargo
features need to be enabled for APIs. This is much friendlier for
users.
## Breaking Changes
None
## Notes & open questions
I'm trying to do this for the entire workspace but for some reason am
not getting this to work on other crates yet. This is all such a
mystery and mess. Just get this in stable rust already and do this by
default without needing extra annotations.
I'll try and do the rest of the workspace still in a followup PR, but
at least this might make the release so we get to see if it works on
actual docs.rs as well.
## Change checklist
- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- ~~[ ] Tests if relevant.~~
- ~~[ ] All breaking changes documented.~~1 parent e3759a6 commit 45a56e2
1 file changed
+10
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
37 | 47 | | |
38 | 48 | | |
0 commit comments