fix a few typos in docs (#884)

This commit is contained in:
joe petrowski
2020-03-06 13:05:53 +01:00
committed by GitHub
parent bae2e79da3
commit 6d3f6bbda6
3 changed files with 30 additions and 30 deletions
+10 -10
View File
@@ -73,7 +73,7 @@ pub struct Config {
/// An abstraction around networking for the availablity-store.
///
/// Currently it is not possible to use the networking code in the availability store
/// core directly due to a number of loop dependencies it require:
/// core directly due to a number of loop dependencies it requires:
///
/// `availability-store` -> `network` -> `availability-store`
///
@@ -102,7 +102,7 @@ pub trait ErasureNetworking {
);
}
/// Data which, when combined with an `AbridgedCandidateReceipt`, is enough
/// Data that, when combined with an `AbridgedCandidateReceipt`, is enough
/// to fully re-execute a block.
#[derive(Debug, Encode, Decode, PartialEq)]
pub struct ExecutionData {
@@ -126,9 +126,9 @@ pub struct Store {
}
impl Store {
/// Create a new `Store` with given condig on disk.
/// Create a new `Store` with given config on disk.
///
/// Creating a store among other things starts a background worker thread which
/// Creating a store among other things starts a background worker thread that
/// handles most of the write operations to the storage.
#[cfg(not(target_os = "unknown"))]
pub fn new<EN>(config: Config, network: EN) -> io::Result<Self>
@@ -145,10 +145,10 @@ impl Store {
})
}
/// Create a new `Store` in-memory. Useful for tests.
/// Create a new in-memory `Store`. Useful for tests.
///
/// Creating a store among other things starts a background worker thread
/// which handles most of the write operations to the storage.
/// that handles most of the write operations to the storage.
pub fn new_in_memory<EN>(network: EN) -> Self
where EN: ErasureNetworking + Send + Sync + Clone + 'static
{
@@ -238,8 +238,8 @@ impl Store {
/// The chunk should be checked for validity against the root of encoding
/// and its proof prior to calling this.
///
/// This method will send the chunk to the background worker, allowing caller to
/// asynchrounously wait for the result.
/// This method will send the chunk to the background worker, allowing the caller to
/// asynchronously wait for the result.
pub async fn add_erasure_chunk(
&self,
candidate: AbridgedCandidateReceipt,
@@ -254,8 +254,8 @@ impl Store {
/// The chunks should be checked for validity against the root of encoding
/// and its proof prior to calling this.
///
/// This method will send the chunks to the background worker, allowing caller to
/// asynchrounously waiting for the result.
/// This method will send the chunks to the background worker, allowing the caller to
/// asynchronously wait for the result.
pub async fn add_erasure_chunks<I>(
&self,
candidate: AbridgedCandidateReceipt,