25e8819 surf: Spellchecking — heartwood

modified crates/radicle-surf/CHANGELOG.md

@@ -13,7 +13,7 @@ changes include:

 - `Browser` is removed. Its methods are implemented directly with `Repository`.
 - Git will be the only supported VCS. Any extension points for other VCSes were
 removed.
 - `Ref` and `RefScope` are removed. Re-use the `git-ref-format` crate and a new
 - `Ref` and `RefScope` are removed. Reuse the `git-ref-format` crate and a new
 `Glob` type for the refspec patterns.
 - Added support of `Tree` and `Blob` that correspond to their definitions in
 Git.

modified crates/radicle-surf/DEVELOPMENT.md

@@ -5,7 +5,7 @@ Thanks for wanting to contribute to `radicle-surf`!

 ## Building & Testing 🏗️
 We try to make development as seemless as possible so we can get down to the real work. We supply
 We try to make development as seamless as possible so we can get down to the real work. We supply
 the toolchain via the `rust-toolchain` file, and the formatting rules `.rustmt.toml` file.
 For the [Nix](https://nixos.org/) inclined there is a `default.nix` file to get all the necessary

@@ -52,7 +52,7 @@ of development.

 If more tests are needed then we should add them under `mod tests` in the relevant module. We strive
 to find properties of our programs so that we can use tools like `proptest` to extensively prove our
 programs are correct. As well as this, we add unit tests to esnure the examples in our heads are
 programs are correct. As well as this, we add unit tests to ensure the examples in our heads are
 correct, and testing out the ergonomics of our API first-hand.
 ## CI files 🤖

modified crates/radicle-surf/README.md

@@ -19,4 +19,4 @@ our [LICENSE](../LICENSE) file.

 ## The Community
 Join our community disccussions at [radicle.community](https://radicle.community)!
 Join our community discussions at [radicle.community](https://radicle.community)!

modified crates/radicle-surf/docs/denotational-design.md

@@ -11,7 +11,7 @@ and view their differences.

 The stream of consciousness that gave birth to this document started with thinking how the user would interact with
 the system, identifying the key components. This is captured in [User Flow](#user-flow). From there we found nouns that
 represent objects in our system and verbs that represent functions over those objects. This iteratively informed us as
 to what other actions we would need to supply. We would occassionally look at [GitHub](todo) and [Pijul Nest](todo) for
 to what other actions we would need to supply. We would occasionally look at [GitHub](todo) and [Pijul Nest](todo) for
 inspiration, since we would like to imitate the features that they supply, and we ultimately want use one or both of
 these for our backends.

@@ -64,7 +64,7 @@ type DirectoryContents

 μ DirectoryContents = IsRepo | Directory | File
 -- Opaque representation of repository state directories (e.g. `.git`, `.pijul`)
 -- Those are not browseable, but have to be present at the repo root 'Directory'.
 -- Those are not browsable, but have to be present at the repo root 'Directory'.
 type IsRepo
 -- A Directory captures its own Label followed by 1 or more DirectoryContents

@@ -91,7 +91,7 @@ type SystemType

   = IsFile
   | IsDirectory
 -- A Chnage is an enumeration of how a file has changed.
 -- A Change is an enumeration of how a file has changed.
 -- This is simply used for getting the difference between two
 -- directories.
 type Change

modified crates/radicle-surf/docs/refactor-design.md

@@ -1,7 +1,7 @@

 # An updated design for radicle-surf
 This is a design blueprint for the new `radicle-git/radicle-surf` crate. The
 actual design details and implemenation are described and updated in its
 actual design details and implementation are described and updated in its
 documentation comments, viewable via `cargo doc`.
 ## Introduction

@@ -107,7 +107,7 @@ Currently we have multiple types to identify a `Commit` or `Revision`.

 The relations between them are: all `Rev` and `Commit` can resolve into `Oid`,
 and in most cases `Rev` can resolve into `Commit`.
 On one hand, `Oid` is the ultimate unique identifer but it is more machine-
 On one hand, `Oid` is the ultimate unique identifier but it is more machine-
 friendly than human-friendly. On the other hand, `Revision` is most human-
 friendly and better suited in the API interface. A conversion from `Revision`
 to `Oid` will be useful.

@@ -138,7 +138,7 @@ Our API will use these traits where we expect a `Revision` or a `Commit`.

 The current `History` is generic over VCS types and also retrieves the full list
 of commits when the history is created. The VCS part can be removed and the
 history can lazy-load the list of commits by implmenting `Iterator` to support
 history can lazy-load the list of commits by implementing `Iterator` to support
  potentially very long histories.
 We can also store the head commit with the history so that it's easy to get

@@ -288,7 +288,7 @@ pub struct History<'a> {

 }
 impl<'a> History<'a> {
     /// This method creats a new `RevWalk` internally and return an
     /// This method creates a new `RevWalk` internally and return an
     /// iterator for all commits in a history.
     pub fn iter(&self) -> impl Iterator<Item = Commit>;
 }

modified crates/radicle-surf/src/fs.rs

@@ -227,7 +227,7 @@ impl Ord for Entry {

 }
 impl Entry {
     /// Get a label for the `Entriess`, either the name of the [`File`],
     /// Get a label for the `Entries`, either the name of the [`File`],
     /// the name of the [`Directory`], or the name of the [`Submodule`].
     pub fn name(&self) -> &String {
         match self {

@@ -296,7 +296,7 @@ impl Entry {

 /// [git-tree]: https://git-scm.com/book/en/v2/Git-Internals-Git-Objects
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Directory {
     /// The name of the directoy.
     /// The name of the directory.
     name: String,
     /// The relative path of the directory, not including the `name`,
     /// in respect to the root of the git repository.

modified crates/radicle-surf/src/test/last_commit.rs

@@ -13,7 +13,7 @@ fn readme_missing_and_memory() {

     let oid =
         Oid::from_str("d3464e33d75c75c99bfb90fa2e9d16efc0b7d0e3").expect("Failed to parse SHA");
     // memory.rs is commited later so it should not exist here.
     // memory.rs is committed later so it should not exist here.
     let memory_last_commit_oid = repo
         .last_commit(&"src/memory.rs", oid)
         .expect("Failed to get last commit")