diff options
author | zach valenta <zjv5002@gmail.com> | 2024-12-09 07:00:04 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-12-09 12:00:04 +0000 |
commit | d499b6e9d3333334614924669b74640a2d0b5485 (patch) | |
tree | b8380e6ecccdaa2a433d74bd101a96160a5563da | |
parent | fb705bb8f4ab7e44900520e018518d12885e0eca (diff) | |
download | git-bug-d499b6e9d3333334614924669b74640a2d0b5485.tar.gz git-bug-d499b6e9d3333334614924669b74640a2d0b5485.zip |
fix typos in docs (#1266)
Co-authored-by: zachvalenta <zvalenta@cappusa.com>
-rw-r--r-- | doc/architecture.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/architecture.md b/doc/architecture.md index 395886ea..e3a7f0b0 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -1,6 +1,6 @@ # Internal architecture -This documentation only provide a bird-eye view of git-bug's internals. For more details, you should read the other documentations and the various comment/documentations scattered in the codebase. +This documentation only provides a bird's-eye view of git-bug's internals. For more details, you should read the other documentation and the various comment/documentation scattered in the codebase. ## Overview @@ -28,7 +28,7 @@ This documentation only provide a bird-eye view of git-bug's internals. For more Here is the internal architecture of git-bug. As you can see, it's a layered architecture. -As a general rule of thumbs, each layer use the directly underlying layer to access and interact with the data. As an example, the `commands` package will not directly use the `bug` or `repository` package. It will request the data from the `cache` layer and go from there. Of course, the `commands` package will ultimately use types defined in the lower level package like `Bug`, but retrieving and changing the data has to go through the `cache` layer to ensure that bugs are properly deduplicated in memory. +As a general rule of thumb, each layer uses the directly underlying layer to access and interact with the data. As an example, the `commands` package will not directly use the `bug` or `repository` package. It will request the data from the `cache` layer and go from there. Of course, the `commands` package will ultimately use types defined in the lower level package like `Bug`, but retrieving and changing the data has to go through the `cache` layer to ensure that bugs are properly deduplicated in memory. ## repository |