diff options
author | Alexei Frolov <frolv@google.com> | 2020-01-10 14:45:43 -0800 |
---|---|---|
committer | CQ Bot Account <commit-bot@chromium.org> | 2020-01-11 01:03:51 +0000 |
commit | 44d5473453771400b9af07219d3435a98298bfa7 (patch) | |
tree | 718669c8406cf181d9753f032560adf0eb8ed1ac /pw_module | |
parent | 9ca7cc394f66f5a9524d4df3fd8489bc251e68bb (diff) | |
download | pigweed-44d5473453771400b9af07219d3435a98298bfa7.tar.gz |
Various small docs fixes
This fixes some typos in the docs.
Change-Id: I4dc2e3b8fa7685bc994123929513a58e8d0e9c79
Diffstat (limited to 'pw_module')
-rw-r--r-- | pw_module/docs.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/pw_module/docs.rst b/pw_module/docs.rst index a5084df75..6893745e3 100644 --- a/pw_module/docs.rst +++ b/pw_module/docs.rst @@ -19,9 +19,9 @@ The Pigweed module structure is designed to keep as much code as possible for a particular slice of functionality in one place. That means including the code from multiple languages, as well as all the related documentation and tests. -Additionally, the structure is desigend to limit the number of places a file +Additionally, the structure is designed to limit the number of places a file could go, so that when reading callsites it is obvious where a header is from. -That is where the duplicated ``<module>`` occurences in file paths comes from. +That is where the duplicated ``<module>`` occurrences in file paths comes from. tl;dr example module structure ------------------------------ @@ -105,17 +105,17 @@ Module name ----------- Pigweed upstream modules are always named with a prefix ``pw_`` to enforce namespacing. Projects using Pigweed that wish to make their own modules can use -whatever name they like, but we suggest picking a short prefix to namespase +whatever name they like, but we suggest picking a short prefix to namespace your product (e.g. for an Internet of Toast project, perhaps the prefix could -be ``it_``. +be ``it_``). C++ file and directory locations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Public headers - ``public/<module>`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Thes are headers that must be exposed due to C++ limitations (i.e. are -included from the public interface, but are not intended for public use) +These are headers that must be exposed due to C++ limitations (i.e. are +included from the public interface, but are not intended for public use). **Public headers** should take the form: |