Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add separate step to GHA workflow for rust doc #116

Merged
merged 5 commits into from
Apr 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ jobs:
- name: Check
run: cargo check

- name: Doc
run: cargo doc --no-deps --workspace --release --document-private-items --bins --examples --all-features

- name: Build
run: cargo build --release --examples

Expand All @@ -56,8 +59,8 @@ jobs:
RUST_BACKTRACE: 1

- name: Generate Documentation
if: ${{ github.ref == 'refs/heads/main' }}
run: |
cargo doc --no-deps -p phaselock -p threshold_crypto --all-features
cp -R target/doc public
echo '<meta http-equiv="refresh" content="0; url=phaselock">' > public/index.html

Expand Down
12 changes: 6 additions & 6 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions libp2p-networking/examples/common/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ impl web::WebInfo for CounterState {
}
}

/// Normal message. Sent amongst [`Regular`] and [`BootStrap`] nodes
/// Normal message. Sent amongst [`NetworkNodeType::Regular`] and [`NetworkNodeType::Bootstrap`] nodes
#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub enum CounterRequest {
/// Request state
Expand All @@ -130,7 +130,7 @@ pub enum CounterRequest {
Kill,
}

/// Message sent between non-[`Conductor`] nodes
/// Message sent between non-[`NetworkNodeType::Conductor`] nodes
#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct NormalMessage {
/// timestamp when message was sent
Expand All @@ -145,8 +145,8 @@ pub struct NormalMessage {
padding: Vec<u64>,
}

/// A message sent and recv-ed by a ['Regular'] or ['Bootstrap'] node
/// that is to be relayed back to a [`Conductor`] node
/// A message sent and recv-ed by a ['NetworkNodeType::Regular'] or ['NetworkNodeType::Bootstrap'] node
/// that is to be relayed back to a [`NetworkNodeType::Conductor`] node
#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct RelayedMessage {
/// time message took to propagate from sender to recv-er
Expand All @@ -157,8 +157,8 @@ pub struct RelayedMessage {
epoch: (CounterState, CounterState),
}

/// A message sent and recv-ed by a ['Regular'] or ['Bootstrap'] node
/// that is to be relayed back to a [`Conductor`] node
/// A message sent and recv-ed by a ['NetworkNodeType::Regular'] or ['NetworkNodeType::Bootstrap'] node
/// that is to be relayed back to a [`NetworkNodeType::Conductor`] node
#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct ConductorMessage {
/// the requeset the recv-ing node should make
Expand Down
2 changes: 1 addition & 1 deletion phaselock-utils/src/subscribable_mutex.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ impl<T> SubscribableMutex<T> {
}
}

/// Wait until `f` returns `true`. Signal on [`ready_chan`]
/// Wait until `f` returns `true`. Signal on `ready_chan`
/// once has begun to listen
async fn wait_until_with_trigger_inner<'a, F>(
&self,
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ fn generate_qc<'a>(
key_set.combine_signatures(signatures)
}

/// Load the latest [`QuorumCertificate`] and the relevant [`Leaf`] and [`State`] from the given [`Storage`]
/// Load the latest [`QuorumCertificate`] and the relevant [`Leaf`] and [`phaselock_types::traits::State`] from the given [`Storage`]
async fn load_latest_state<I: NodeImplementation<N>, const N: usize>(
storage: &I::Storage,
) -> std::result::Result<
Expand Down
4 changes: 2 additions & 2 deletions src/traits/storage/atomic_storage/hash_map_store.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ where
inner: RwLock<Inner<K, V>>,
}

/// The inner value of the [`RollingStore`]
/// The inner value of the [`HashMapStore`]
struct Inner<K, V>
where
K: Eq + Hash,
Expand All @@ -33,7 +33,7 @@ where
V: Clone,
HashMap<K, V>: Serialize + DeserializeOwned + Clone,
{
/// Load a `RollingStore` with the given loader and name.
/// Load a `HashMapStore` with the given loader and name.
///
/// # Errors
///
Expand Down