diff --git a/docs/contributing-book/src/code_docs/naming-components.md b/docs/contributing-book/src/code_docs/naming-components.md index 7b5a058c..a65f6466 100644 --- a/docs/contributing-book/src/code_docs/naming-components.md +++ b/docs/contributing-book/src/code_docs/naming-components.md @@ -26,11 +26,11 @@ Using a single character to name a variable conveys little to no information to - Is this a throw away variable? - What is the variable meant to represent where ever it is used? -- Does it make sense to call it by the chosen character e.g. `x` when referring to forumlas? +- Does it make sense to call it by the chosen character e.g. `x` when referring to formulas? -### Ambigious Abbreviations +### Ambitious Abbreviations -A common mistake is to abbreviate a variable when it does not need to be abbreviated or when the abbreviation may be ambigious. +A common mistake is to abbreviate a variable when it does not need to be abbreviated or when the abbreviation may be ambitious. For example, in the context of an industry that deals with temperature sensors what does the variable `temp` refer to? diff --git a/docs/contributing-book/src/code_docs/specification.md b/docs/contributing-book/src/code_docs/specification.md index b7e9d968..4bd90f9b 100644 --- a/docs/contributing-book/src/code_docs/specification.md +++ b/docs/contributing-book/src/code_docs/specification.md @@ -2,7 +2,7 @@ A specification is a document which outlines the requirements and design of the library. There are many ways to structure a specification and this number only grows when considering the industry and target audience. -For simplicity, a specification can be broken into two levels of detail and the one you choose depends on your target audiance. +For simplicity, a specification can be broken into two levels of detail and the one you choose depends on your target audience. ## Non-technical specification diff --git a/docs/contributing-book/src/pull-requests/index.md b/docs/contributing-book/src/pull-requests/index.md index b5e23cf3..9feb66f4 100644 --- a/docs/contributing-book/src/pull-requests/index.md +++ b/docs/contributing-book/src/pull-requests/index.md @@ -1,6 +1,6 @@ # Pull Requests -A pull request is a term used to identify when a piece of work is ready to be pulled into and merged with another piece of work. This funtionality is especially useful when collaborating with others because it allows a review process to take place. +A pull request is a term used to identify when a piece of work is ready to be pulled into and merged with another piece of work. This functionality is especially useful when collaborating with others because it allows a review process to take place. In order to create a high quality pull request there are a couple areas that need to be considered: