Draft
Conversation
Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
Fredi-raspall
force-pushed
the
pr/fredi/only_internal_docs_experiment
branch
from
d4eeb11 to
6b591ab
Compare
Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
qmonnet
reviewed
Nov 21, 2025
.github/workflows/dev.yml
Outdated
|
|
||
| - id: "docs" | ||
| name: "run rustdoc" | ||
| if: ${{matrix.profile.name == 'release'}} |
qmonnet
reviewed
Nov 21, 2025
|
|
||
| #![deny(clippy::all, clippy::pedantic)] | ||
| #![deny(rustdoc::all)] | ||
| #![allow(rustdoc::broken_intra_doc_links)] |
Member
There was a problem hiding this comment.
I'd rather not ignore these reports, could we fix the docs in nat instead?
I took a quick look and the only one I got to fix was:
diff --git i/nat/src/stateful/apalloc/setup.rs w/nat/src/stateful/apalloc/setup.rs
index 71508eb41328..f83f525c44ad 100644
--- i/nat/src/stateful/apalloc/setup.rs
+++ w/nat/src/stateful/apalloc/setup.rs
@@ -19,8 +19,9 @@ use std::time::Duration;
use tracing::debug;
impl NatDefaultAllocator {
- /// Build a [`NatDefaultAllocator`] from information collected from a [`VpcTable`] object. This
- /// information is passed as a [`StatefulNatConfig`].
+ /// Build a [`NatDefaultAllocator`] from information collected from a
+ /// [`VpcTable`][config::external::overlay::vpc::VpcTable] object.
+ /// This information is passed as a [`StatefulNatConfig`].
///
/// # Returns
///Let me know if you got more, if I can reproduce I'm happy to address them in a separate PR.
Contributor
Author
There was a problem hiding this comment.
I think there were very few. Happy if we fix the docs in each crate, more than brutally disabling the lints as I did.
Allow skipping docs based on label Signed-off-by: Fredi Raspall <fredi@githedgehog.com>
Fredi-raspall
force-pushed
the
pr/fredi/only_internal_docs_experiment
branch
from
e522b8d to
308ec76
Compare
Fredi-raspall
added
the
disable-docs
Member
|
Note: #1069 introduced a conflict with your branch |
qmonnet
reviewed
Dec 15, 2025
| if: ${{ matrix.profile.name == 'release' && !contains(github.event.pull_request.labels.*.name, 'disable-docs') }} | ||
| run: | | ||
| RUSTDOCFLAGS="-D warnings" just \ | ||
| RUSTDOCFLAGS="-D warnings --document-private-items --allow rustdoc::all" just \ |
Member
There was a problem hiding this comment.
What does --allow rustdoc::all do here? Won't it turn off all reports from rustdoc?
Contributor
|
Can we close this? @Fredi-raspall @qmonnet ? |
Member
|
Oh please don't close it, I'd like work on this to resume and get merged. CI takes so long these days, if we can save on doc builds that's great. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.