Skip to content

Commit 5569ef1

Browse files
committed
Include the raw module in docs
1 parent f739d6f commit 5569ef1

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ matrix:
1313
- name: "docs"
1414
env: TARGET=x86_64-unknown-linux-gnu
1515
script:
16-
- cargo -vv doc --features nightly,serde,rayon
16+
- cargo -vv doc --features nightly,serde,rayon,raw
1717
- echo '<meta http-equiv=refresh content=0;url=hashbrown/index.html>' > target/doc/index.html
1818
deploy:
1919
provider: pages

Cargo.toml

+3
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,6 @@ nightly = []
3939
rustc-internal-api = []
4040
rustc-dep-of-std = ["nightly", "core", "compiler_builtins", "alloc", "rustc-internal-api"]
4141
raw = []
42+
43+
[package.metadata.docs.rs]
44+
features = ["nightly", "rayon", "serde", "raw"]

src/lib.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ doc_comment::doctest!("../README.md");
4343
#[macro_use]
4444
mod macros;
4545

46-
// The RawTable API is still experimental and is not properly documented yet.
4746
#[cfg(feature = "raw")]
48-
#[allow(missing_docs)]
47+
/// Experimental and unsafe `RawTable` API. This module is only available if the
48+
/// `raw` feature is enabled.
4949
pub mod raw {
50+
// The RawTable API is still experimental and is not properly documented yet.
51+
#[allow(missing_docs)]
5052
#[path = "mod.rs"]
5153
mod inner;
5254
pub use inner::*;

0 commit comments

Comments
 (0)