Skip to content

Commit 9fa80ef

Browse files
committed
Move deny missing_docs to ci-doc.sh
1 parent e5892a2 commit 9fa80ef

File tree

2 files changed

+1
-4
lines changed

2 files changed

+1
-4
lines changed

.github/scripts/ci-doc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# If the output path is changed in this script, we need to update rustdoc.yml as well.
55

66
# deny warnings for rustdoc
7-
export RUSTDOCFLAGS="-D warnings"
7+
export RUSTDOCFLAGS="-D warnings -D missing_docs"
88

99
# Check cargo doc
1010
# We document public and private items for MMTk developers (GC implementers).

src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
// Deny missing_docs: if any public item does not have a proper rustdoc comment, the build will fail.
2-
// We try to keep the code well documented, especially for items in our public API.
3-
#![deny(missing_docs)]
41
// Allow this for now. Clippy suggests we should use Sft, Mmtk, rather than SFT and MMTK.
52
// According to its documentation (https://rust-lang.github.io/rust-clippy/master/index.html#upper_case_acronyms),
63
// with upper-case-acronyms-aggressive turned on, it should also warn us about SFTMap, VMBinding, GCWorker.

0 commit comments

Comments
 (0)