Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix some comments #282

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −5
Open

chore: fix some comments #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contributing-book/src/code_docs/naming-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-book/src/code_docs/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-book/src/pull-requests/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down