summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Jeremie Guichard <djebrest@gmail.com>2018-04-09 07:59:33 +0200
committerGravatar Dirk Hohndel <dirk@hohndel.org>2018-04-09 07:48:01 -0700
commitf633cb81ae095ea128a406e69b5eecab23be92a9 (patch)
tree2a0737a74ff7007b51570488413ce9435f98976f
parentd64c48855df647cc4d80fba6874ae6f89511f7d3 (diff)
downloadsubsurface-f633cb81ae095ea128a406e69b5eecab23be92a9.tar.gz
Fix minor typos and spelling mistakes in README.md and related
Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
-rw-r--r--CONTRIBUTING.md4
-rw-r--r--CodingStyle12
-rw-r--r--README.md4
-rw-r--r--Readme.testing6
-rw-r--r--terms6
5 files changed, 16 insertions, 16 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a82a797f3..68ea8ca12 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,7 +37,7 @@ Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.
-The body of the commit message can be several paragrahps, and
+The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
74 characters or so. That way "git log" will show things
nicely even when it's indented.
@@ -47,7 +47,7 @@ Signed-off-by: Your Name
That header line really should be meaningful, and really should be just one line. The header line is what is shown by tools like gitk and shortlog, and should summarize the change in one readable line of text, independently of the longer explanation.
-The prefered way to write a commit message is using imperative mood, e.g. "Make foo do xyz" instead of "This patch makes foo do xyz" or "I made foo do xyz", as if you are giving commands or requests to the code base.
+The preferred way to write a commit message is using imperative mood, e.g. "Make foo do xyz" instead of "This patch makes foo do xyz" or "I made foo do xyz", as if you are giving commands or requests to the code base.
https://en.wikipedia.org/wiki/Imperative_mood
![gitk sample][10]
diff --git a/CodingStyle b/CodingStyle
index 9e965a401..52fab7344 100644
--- a/CodingStyle
+++ b/CodingStyle
@@ -19,7 +19,7 @@ Basic rules
===========
- all indentation is tabs (set to 8 char) with the exception of
- continuation lines that are alligned with tabs and then spaces
+ continuation lines that are aligned with tabs and then spaces
- all keywords followed by a '(' have a space in between
@@ -65,7 +65,7 @@ Basic rules
- continuation lines have the operator / comma at the end
- if (very_long_conditiont_1 ||
+ if (very_long_condition_1 ||
condition_2)
b = a + (c + d +
@@ -126,13 +126,13 @@ Basic rules
- UI text style
- These guidleines are designed to ensure consitency in presentation within
+ These guidelines are designed to ensure consistency in presentation within
Subsurface.
- Only the first word of multi-word text strings should be captalized unless
- a word would normally be capitalized mid-sentance, like Africa. This applies
+ Only the first word of multi-word text strings should be capitalized unless
+ a word would normally be capitalized mid-sentence, like Africa. This applies
to all UI text including menus, menu items, tool-tips, button text and label
text etc. e.g. "Check for updates" rather than "Check for Updates".
- We also captialize Subsurface (NOTE: not SubSurface) when referring to the
+ We also capitalize Subsurface (NOTE: not SubSurface) when referring to the
application itself.
Abbreviations should end with a period, e.g. "temp." not "temp" for
temperature
diff --git a/README.md b/README.md
index bcc1e65fe..95c2d6231 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ https://github.com/Subsurface-divelog/subsurface/issues
License: GPLv2
-We frequently make new test versions of Subsurface avilable at
+We frequently make new test versions of Subsurface available at
http://subsurface-divelog.org/downloads/test/
These tend to contain the latest bug fixes and features, but also
occasionally the latest bugs and issues. Please understand when using them
@@ -101,7 +101,7 @@ to subscribe.
If you want to contribute code, please open a pull request with signed-off
commits at https://github.com/Subsurface-divelog/subsurface/pulls
(alternatively, you can also send your patches as emails to the developer
-mailing lsit).
+mailing list).
Either way, if you don't sign off your patches, we will not accept them.
This means adding a line that says "Signed-off-by: Name <email>" at the
diff --git a/Readme.testing b/Readme.testing
index a229e3a16..bab813110 100644
--- a/Readme.testing
+++ b/Readme.testing
@@ -5,11 +5,11 @@ to compile the source code of the tests and run them.
1 - create a folder 'build-tests' on the project root directory
2 - run cmake ( cmake .. )
-3 - compile the software by invocking make
-4 - run the tests by invocking make test
+3 - compile the software by invoking make
+4 - run the tests by invoking make test
(optional 5) if the tests are failing, a better way to see what's
happening is to run ctest -V , this way the tests will still fail,
-but more verbosically - easyer to track them down.
+but more verbosely - easier to track them down.
to create a new test, just implement copy the one provided by
example in the tests folder and add the last three lines of the CMakeLists.txt file
diff --git a/terms b/terms
index f3743bc9f..37545298a 100644
--- a/terms
+++ b/terms
@@ -69,7 +69,7 @@ trip dives are grouped into "trips" based on their
UDDF standardized file format
-GFHigh, GFLow Gradient Factors of the Buehlman algorithm. These
+GFHigh, GFLow Gradient Factors of the Buehlmann algorithm. These
impact the way the deco obligations are calculated
in Subsurface. Typically these are between 20 and 100.
Lower is more conservative (i.e., more deco). It's
@@ -106,7 +106,7 @@ rbt remaining bottom time
rgt remaining gas time
-workload is this a strenous dive?
+workload is this a strenuous dive?
deepstop stop well below the ceiling
@@ -114,7 +114,7 @@ safety stop stop at the end of a recreational dive, typically
3 minutes at 5 meters
below floor event showing dive is below the depth where the dive
- is acruing additional deco time
+ is accruing additional deco time
OLF Oxygen Limit Fraction; Suunto specific term for CNS