Merge pull request #69 from Anders429/doc_ci

Check documentation on CI.

.github/workflows/test.yaml

@@ -102,6 +102,36 @@ jobs:
         command: hack
         args: clippy --feature-powerset --optional-deps -- --deny warnings
 
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: nightly
+        override: true
+    - uses: actions-rs/cargo@v1
+      with:
+        command: doc
+        args: --no-deps --all-features
+      env:
+        RUSTDOCFLAGS: --cfg doc_cfg -D warnings
+
+  private_doc:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        toolchain: nightly
+        override: true
+    - uses: actions-rs/cargo@v1
+      with:
+        command: doc
+        args: --no-deps --all-features --document-private-items
+      env:
+        RUSTDOCFLAGS: --cfg doc_cfg -D warnings
+
   msrv:
     runs-on: ubuntu-latest
     steps:

src/query/view/assertion_buffer.rs

@@ -37,6 +37,8 @@ impl AssertionBuffer {
     /// Create a new empty buffer.
     ///
     /// It is recommended to use [`with_capacity`] if possible, as it will save allocations.
+    ///
+    /// [`with_capacity`]: AssertionBuffer::with_capacity()
     #[cfg(feature = "parallel")]
     pub(crate) fn new() -> Self {
         Self::with_capacity(0)

src/registry/seal/assertions.rs

@@ -1,11 +1,10 @@
 //! This module defines and implements assertions on a [`Registry`].
 //!
 //! All assertions on invariants that must be upheld by a `Registry` should be included within the
-//! `Assertions` trait defined here. This trait acts as an extension to the [`registry::Seal`]
+//! `Assertions` trait defined here. This trait acts as an extension to the `registry::Seal`
 //! trait, implementing it on all registries.
 //!
 //! [`Registry`]: crate::registry::Registry
-//! [`registry::Seal`]: crate::registry::seal::Seal;
 
 use crate::{component::Component, registry::Null};
 use core::any::TypeId;