From 0b816d5c8662df961da19e1faabc126a9e7b536f Mon Sep 17 00:00:00 2001 From: cloudhead Date: Mon, 29 Apr 2024 13:28:31 +0200 Subject: [PATCH] docs: Typo fixes Nb. This was submitted by user `@omahs` via GitHub, but since an email address was not included in the commits, I've used my own. --- CONTRIBUTING.md | 2 +- HACKING.md | 2 +- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da03169b..d706d4c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,7 +51,7 @@ The following code guidelines will help make code review smoother. Use `unwrap` only in either of three circumstances: -1. Based on manual static anaylsis, you've concluded that it's impossible for +1. Based on manual static analysis, you've concluded that it's impossible for the code to panic; so unwrapping is *safe*. An example would be: let list = vec![a, b, c]; diff --git a/HACKING.md b/HACKING.md index 01862477..d50904db 100644 --- a/HACKING.md +++ b/HACKING.md @@ -22,7 +22,7 @@ The repository is structured in *crates*, as follows: * `radicle-cli-test`: The Radicle CLI testing framework, for writing documentation tests. * `radicle-cob`: Radicle Collaborative Objects (COBs). Provides a way of creating and traversing edit histories. * `radicle-crdt`: Conflict-free replicated datatypes (CRDTs) used for things like discussions and patches. -* `radicle-crypto`: A wrapper around Ed25519 cryptographic signing primitives . +* `radicle-crypto`: A wrapper around Ed25519 cryptographic signing primitives. * `radicle-dag`: A simple directed acyclic graph implementation used by `radicle-cob`. * `radicle-httpd`: The radicle HTTP daemon that serves API clients and Git fetch requests. * `radicle-node`: The radicle peer-to-peer daemon that enables users to connect to the network and share code. diff --git a/README.md b/README.md index 32d5af64..8b813bf9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Heartwood is the third iteration of the Radicle Protocol, a powerful peer-to-peer code collaboration and publishing stack. The repository contains a -full implemention of Heartwood, complete with a user-friendly command-line +full implementation of Heartwood, complete with a user-friendly command-line interface (`rad`) and network daemon (`radicle-node`). Radicle was designed to be a secure, decentralized and powerful alternative to