Skip to content

Commit

Permalink
Fix minor typos and spelling mistakes in README.md and related
Browse files Browse the repository at this point in the history
Signed-off-by: Jeremie Guichard <[email protected]>
  • Loading branch information
dje29 authored and dirkhh committed Apr 9, 2018
1 parent d64c488 commit f633cb8
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]
Expand Down
12 changes: 6 additions & 6 deletions CodingStyle
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 +
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Readme.testing
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions terms
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -106,15 +106,15 @@ 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

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

Expand Down

0 comments on commit f633cb8

Please sign in to comment.