From 922df2a10f5296870a37843cd9276144f5858569 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 29 Mar 2023 11:42:01 +0100 Subject: [PATCH 1/2] CONTRIBUTING.md: Recommend --workspace when building docs --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04b8ec410..8a5c24ddf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,7 +166,8 @@ information. This code does not attempt to be indistinguishable from the current Tor implementation. -When building the docs with `cargo doc`, use `--all-features`, or you may -find broken links. (We welcome fixes to links broken with `--all-features`.) +When building the docs with `cargo doc`, use `--workspace --all-features`, +or you may find broken links. +(We welcome fixes to links broken with `--all-features`.) Enjoy hacking on arti! From ab7e628555337497eaeb3ed9c1b3b287a84ffb54 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 29 Mar 2023 11:43:22 +0100 Subject: [PATCH 2/2] CONTRIBUTING.md: Explicitly support --document-private-items We have many internal doc comments with curated links etc., so we should actually mention that formatting and reading those can be useful. --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a5c24ddf..ea35d877d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,6 +168,8 @@ implementation. When building the docs with `cargo doc`, use `--workspace --all-features`, or you may find broken links. -(We welcome fixes to links broken with `--all-features`.) +(We welcome fixes to links broken with `--all-features`. +`cargo doc --workspace --all-features --document-private-items` +is also supported, to reveal (unstable) internal information.) Enjoy hacking on arti!