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.

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

docs: fix spelling and grammatical errors #484

Closed
wants to merge 2 commits into from
Closed

docs: fix spelling and grammatical errors #484

wants to merge 2 commits into from

Conversation

akshkr
Copy link

@akshkr akshkr commented Nov 3, 2017

Closes #478

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • I read the commit guidelines and I've followed
    them.
  • I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!


All settings specified here override only settings given by the system
wide coafile which has the lowest priority. The ``default_coafile`` must
All settings specified here override only settings given by the system-wide

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmp4kya1uw6/Users/coafile.rst
+++ b/tmp/tmp4kya1uw6/Users/coafile.rst
@@ -34,7 +34,7 @@
 user wide settings. Those settings will automatically be taken for all
 projects executed by that user.
 
-All settings specified here override only settings given by the system-wide 
+All settings specified here override only settings given by the system-wide
 coafile which has the lowest priority. The ``default_coafile`` must
 lie in the coala installation directory and is valid for everyone using
 this coala installation.

lie in the coala installation directory and is valid for everyone using
this coala installation.

Explicit Setting Inheritance
----------------------------

Every coafile contains one or more sections. Section names are case
insensitive. The old(pre 0.11.x) implicit section inheritance syntax
Every coafile contains one or more sections. Section names are case-insensitive.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmp4kya1uw6/Users/coafile.rst
+++ b/tmp/tmp4kya1uw6/Users/coafile.rst
@@ -42,7 +42,7 @@
 Explicit Setting Inheritance
 ----------------------------
 
-Every coafile contains one or more sections. Section names are case-insensitive. 
+Every coafile contains one or more sections. Section names are case-insensitive.
 The old(pre 0.11.x) implicit section inheritance syntax
 has been deprecated and has been scheduled for removal in coala version 0.12.0.
 Instead, define section inheritance explicitly by naming a section in the

lie in the coala installation directory and is valid for everyone using
this coala installation.

Explicit Setting Inheritance
----------------------------

Every coafile contains one or more sections. Section names are case
insensitive. The old(pre 0.11.x) implicit section inheritance syntax
Every coafile contains one or more sections. Section names are case-insensitive.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (81 > 79)

Origin: LineLengthBear, Section: docs.

Help/FAQ.rst Outdated
@@ -127,7 +127,7 @@ our master branch. Right now we use 7 of those checks:
`here <http://api.coala.io/en/latest/Developers/Review.html>`_.

- **codecov/project** This one checks whether all your code is being tested. We
cannot merge anything that may not work or may broke somewhere, so to avoid
cannot merge anything that may not work or may be broken somewhere, so to avoid

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (81 > 79)

Origin: LineLengthBear, Section: docs.


All settings specified here override only settings given by the system
wide coafile which has the lowest priority. The ``default_coafile`` must
All settings specified here override only settings given by the system-wide

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmp4kya1uw6/Users/coafile.rst
+++ b/tmp/tmp4kya1uw6/Users/coafile.rst
@@ -34,7 +34,7 @@
 user wide settings. Those settings will automatically be taken for all
 projects executed by that user.
 
-All settings specified here override only settings given by the system-wide 
+All settings specified here override only settings given by the system-wide
 coafile which has the lowest priority. The ``default_coafile`` must
 lie in the coala installation directory and is valid for everyone using
 this coala installation.

lie in the coala installation directory and is valid for everyone using
this coala installation.

Explicit Setting Inheritance
----------------------------

Every coafile contains one or more sections. Section names are case
insensitive. The old(pre 0.11.x) implicit section inheritance syntax
Every coafile contains one or more sections. Section names are case-insensitive.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmp4kya1uw6/Users/coafile.rst
+++ b/tmp/tmp4kya1uw6/Users/coafile.rst
@@ -42,7 +42,7 @@
 Explicit Setting Inheritance
 ----------------------------
 
-Every coafile contains one or more sections. Section names are case-insensitive. 
+Every coafile contains one or more sections. Section names are case-insensitive.
 The old(pre 0.11.x) implicit section inheritance syntax
 has been deprecated and has been scheduled for removal in coala version 0.12.0.
 Instead, define section inheritance explicitly by naming a section in the

lie in the coala installation directory and is valid for everyone using
this coala installation.

Explicit Setting Inheritance
----------------------------

Every coafile contains one or more sections. Section names are case
insensitive. The old(pre 0.11.x) implicit section inheritance syntax
Every coafile contains one or more sections. Section names are case-insensitive.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (81 > 79)

Origin: LineLengthBear, Section: docs.

Help/FAQ.rst Outdated
@@ -127,7 +127,7 @@ our master branch. Right now we use 7 of those checks:
`here <http://api.coala.io/en/latest/Developers/Review.html>`_.

- **codecov/project** This one checks whether all your code is being tested. We
cannot merge anything that may not work or may broke somewhere, so to avoid
cannot merge anything that may not work or may be broken somewhere, so to avoid

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (81 > 79)

Origin: LineLengthBear, Section: docs.

@@ -6,7 +6,7 @@ coala configuration file. It is meant to be rather factual. If you wish
to learn by example, please take a look at :doc:`Tutorial`. It also
teaches how to change settings inside a coala file to suit your taste.

Naming, Scope and Location
Naming, Scope, and Location
--------------------------
Copy link
Member

@RaiVaibhav RaiVaibhav Nov 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add one more - to avoid warning WARNING: Title underline too short. in TRAVIS

@jayvdb
Copy link
Member

jayvdb commented Nov 3, 2017

@AI-coder , you have done one newcomer issue. Fixing individual spelling mistakes are newcomer issues.
The bug you are solving was low because it was about adding a spell checker bear, which is not what you are doing in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Detect and prevent spelling errors in documentation
4 participants