laskoviymishka commented on code in PR #3389:
URL: https://github.com/apache/iceberg-rust/pull/3389#discussion_r4242731440
##########
Makefile:
##########
@@ -26,6 +26,9 @@ check-fmt:
check-clippy:
cargo clippy --all-targets --all-features --workspace -- -D warnings
+check-doc:
+ RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features
--workspace
Review Comment:
`-D warnings` here also denies the rustdoc link/HTML lints —
`invalid_html_tags` in particular trips on unescaped `<...>` in docstrings
(`Map<K,V>`, `List<Struct>`), which show up a lot in spec-flavored comments.
The diff has no doc fixes, so I'd confirm this branch's CI is actually green on
the pinned nightly before merge rather than assume the tree was already clean
under this flag.
##########
.github/workflows/ci.yml:
##########
@@ -122,6 +122,9 @@ jobs:
- name: Cargo clippy
run: make check-clippy
+ - name: Cargo doc
Review Comment:
The description says this lands in the `lint` job, but it's actually in
`clippy` (`needs: lint`, with setup-builder) — fine by me, sharing the warm
toolchain and cache beats a cold standalone job, just worth fixing the
description to match.
One consequence of the placement: a rustdoc failure now surfaces under the
"clippy" check rather than as its own. If we'd rather it be a distinct required
check, a separate `doc` job added to `ci-required.needs` does it — optional,
not for this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
