Skip to content

docs: fix spelling and grammatical errors #484

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions Help/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ What does coala do (for me)?
coala is like a spell and grammar checker for source code. It offers one
command and one configuration to lint all languages in your project.

In short coala does two things:
In short, coala does two things:

- Makes it easy to use existing static code analyzers such as clang,
pylint(and many others) by unifying and simplifying the configs
Expand Down Expand Up @@ -48,7 +48,7 @@ What sort of analysis does coala do? What languages are supported?
A list of all analysis routines and supported languages is
`fully browsable <https://github.com/coala/bear-docs/blob/master/README.rst#supported-languages>`__.

For a top level view on what languages support what kind of analysis roughly,
For a top-level view on what languages support what kind of analysis roughly,
consult `this link <https://docs.google.com/spreadsheets/d/1bm63TQHndmGf3HQ33fp9UEmGKNYI7dTkjMyFIof2PqA/edit?usp=sharing>`__.

There are also generic bears, which can be applied language independently on
Expand Down Expand Up @@ -113,7 +113,7 @@ our master branch. Right now we use 7 of those checks:
issues.

- **review/gitmate/pr** Checks whether your code respects our styling (PEP8),
doesn't contain unneeded newlines, trailing whitespace, etc. Basically it is
doesn't contain unneeded newlines, trailing whitespace, etc. Basically, it is
like running coala over your code, so to fix this, simply run ``$ coala``
before pushing! In case you have multiple commits, and the issue is in one
of them, the status will still be failed, so be careful to run ``$ coala``
Expand All @@ -126,10 +126,10 @@ our master branch. Right now we use 7 of those checks:
it all documented
`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
obvious bugs we use this. To fix it, write doctests or unittests for your
functions / classes.
- **codecov/project** This one checks whether all your code is being tested.
We cannot merge anything that may not work or may be broken somewhere, so to
avoid obvious bugs we use this. To fix it, write doctests or unittests for
your functions / classes.

- **ci/circleCI** This is one of the two containers we use to continuously
test the code. It basically runs all the tests and checks your code in a
Expand Down
2 changes: 1 addition & 1 deletion Help/Getting_In_Touch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ We appreciate any help. (Partially with words, partially with chocolate
if you live near Hamburg or join us at conferences.)

Modularity, clean good code as well as a high usability for both users
and developers of analyse routines (called bears) stand in the
and developers of analyze routines (called bears) stand in the
foreground of the development. We will not speed up our development if
it needs sacrificing any aspect of quality.
4 changes: 2 additions & 2 deletions Help/MAC_Hints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ venv
----

Here we will be using ``venv``, which is part of python's standard
libary since python 3.3, to create a virtualenv for development.
library since python 3.3, to create a virtualenv for development.

1. Make sure you have installed Xcode and Homebrew.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2. Install Python 3.
~~~~~~~~~~~~~~~~~~~~

For coala you will need to use Python 3, so you may
For coala, you will need to use Python 3, so you may
simply use homebrew to install Python 3, or you could also
`refer to the pyenv section <#pyenv>`__ to install Python 3 while you can also
maintain other python versions.
Expand Down
6 changes: 3 additions & 3 deletions Users/Glob_Patterns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Suppose you want ``SpaceConsistencyBear`` to perform an analysis on a file
with a bear, you should go through `Tutorial
<http://coala.readthedocs.io/en/latest/Users/Tutorial.html>`_ first.

Now, if you want all the ``.c`` files in a specific directory to be analysed,
Now, if you want all the ``.c`` files in a specific directory to be analyzed,
you can take help of glob patterns.
::

Expand Down Expand Up @@ -44,7 +44,7 @@ subdirectories, you can use ``**`` glob pattern for that.

In coala, files and directories are specified by file name. To allow
input of multiple files without requiring a large number of filenames,
coala supports a number of wildcards. These are based on the unix-style
coala supports a number of wildcards. These are based on the Unix-style
glob syntax and they are *not* the same as regular expressions.

.. note::
Expand Down Expand Up @@ -148,7 +148,7 @@ brackets have to be placed at the first position.
Matches either sequence\_a or sequence\_b as a whole. More than two
or just one sequence can be given.

Parentheses cannot be part of an alternative, unless they are escaped by
Parentheses cannot be part of an alternative unless they are escaped by
brackets. Parentheses that have no match are ignored as well as
``|``-separators that are not inside matching parentheses.

Expand Down
10 changes: 5 additions & 5 deletions Users/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Installing coala
----------------

There are three ways of installing coala. By using a virtualenv, by installing
it system-wide or directly from source.
it system-wide or directly from the source.

After successfully installing coala, you will need to install all the
dependencies the bears have.
Expand Down Expand Up @@ -220,7 +220,7 @@ order for them to be usable, you need to install them via ``npm``
$ npm install -g

If a bear still doesn't work for you, please make sure that you have a
recent version of ``npm`` installed. Many linux distributions ship a
recent version of ``npm`` installed. Many Linux distributions ship a
very old one.

Ruby Dependencies
Expand Down Expand Up @@ -287,7 +287,7 @@ Replace "XXX" with the ClangSharp version you received from nuget.
Shell-Autocompletion Support
----------------------------

If you are a bash/zsh user , checkout the
If you are a bash/zsh user, check out the
`guide <https://docs.coala.io/en/latest/Users/Shell_Autocompletion.html>`_
to set up autocompletion for coala arguments and bear names.

Expand Down Expand Up @@ -327,14 +327,14 @@ First you need to install the requirements:
$ pip3 install -r docs-requirements.txt

To generate the documentation coala uses `sphinx`. Documentation can be
generated by running the following command while in root directory of the
generated by running the following command while in the root directory of the
repository:

::

$ make html

You can then open ``_build\html\index.html`` in your favourite
You can then open ``_build\html\index.html`` in your favorite
browser.

See `Writing Documentation <http://api.coala.io/en/latest/Developers/Writing_Documentation.html>`_
Expand Down
2 changes: 1 addition & 1 deletion Users/Shell_Autocompletion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Install ``argcomplete``:

$ pip install argcomplete

After this you have to either activate it
After this, you have to either activate it
`globally <https://github.com/kislyuk/argcomplete#activating-global-completion>`__
or modify your configuration.

Expand Down
16 changes: 8 additions & 8 deletions Users/Tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ to the usage of coala.
Prerequisites
-------------

In order to complete this tutorial you will need coala installed.
In order to complete this tutorial, you will need coala installed.
Installation instructions can be found `here <https://coala.io/install>`_.

.. note::
Expand All @@ -20,7 +20,7 @@ Installation instructions can be found `here <https://coala.io/install>`_.
Get Some Code
-------------

In order to perform a static code analysis on your code you will need
In order to perform a static code analysis on your code, you will need
some code to check. If you do not have your own code you want to check, you
can retrieve our tutorial samples:

Expand Down Expand Up @@ -102,7 +102,7 @@ patch (option 2).
| | 4: Add ignore comment
| | Enter number (Ctrl-D to exit): 2

If the patch was applied succesfully, you should see something like this:
If the patch was applied successfully, you should see something like this:

::

Expand All @@ -115,16 +115,16 @@ If the patch was applied succesfully, you should see something like this:

Exit by pressing Ctrl-D.

You can also run coala in non interactive mode (given that all the settings
You can also run coala in non-interactive mode (given that all the settings
required by the bears you are using are provided in the ``.coafile``)

::

coala --non-interactive

In this case there won't be any interaction, the patch will be shown directly.
In this case, there won't be any interaction, the patch will be shown directly.

Feel free to experiment a bit. You've successfully analysed some code!
Feel free to experiment a bit. You've successfully analyzed some code!
But don't stop reading - you don't have to enter all those values again!
We have given coala the ``--save`` argument, which means that it will
automatically generate a ``.coafile`` into the current directory. Read on!
Expand Down Expand Up @@ -166,7 +166,7 @@ into your ``.coafile``.
Sections
--------

Thats all nice and well but we also have a Makefile for our project we
That's all nice and well but we also have a Makefile for our project we
want to check. So let us introduce another feature of our configuration
syntax: *sections*.

Expand Down Expand Up @@ -355,7 +355,7 @@ specify glob wildcards that match several bears:
another_unwrappable_string = unwrappable_string + unwrappable_string_2
# Stop ignoring

In the above example all bears matching the glob `Line*` and `Py*` will
In the above example, all bears matching the glob `Line*` and `Py*` will
be ignored. You may also specify more complex globs here such as
`# Start ignoring (Line*|P[yx]*)` which will ignore all bears' names which
start with `Line`, `Py`, and `Px`.
Expand Down
18 changes: 9 additions & 9 deletions Users/coafile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


You can use up to three coafiles to configure your project.
Expand All @@ -32,19 +32,19 @@ User-Wide and System-Wide coafile

You can place a ``.coarc`` file in your home directory to set certain
user wide settings. Those settings will automatically be taken for all
projects executed with that user.
projects executed by that user.

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
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.

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
has been deprecated and has been scheduled for removal in coala version 0.12.0.
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
format ``[basesection.newsection]``. Extra values can be appended to an
inherited setting using the ``+=`` operator.
Expand Down Expand Up @@ -113,7 +113,7 @@ Defining Aspects and Tastes
Aspects is an alternative way to configure coala. In this mode, we don't need
to explicitly state list of bears, coala will choose it automatically based on
requested aspects in coafile. To run coala in this mode, we need to define
`aspects`, `files`, `languages`, and optionally aspect tastes setting. See
`aspects`, `files`, `languages`, and optionally aspect taste setting. See
the following example::

[all]
Expand All @@ -132,7 +132,7 @@ the following example::
# excluding certain subaspect
excludes = AspectName2Subaspect

Comments, Escaping and Multiline Values and Keys
Comments, Escaping, and Multiline Values and Keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Comments are simply done with a preceding ``#``. If you want to use a
Expand Down
2 changes: 1 addition & 1 deletion Users/coala_as_Git_Hook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ can make it executable by running

$ chmod +x .git/hooks/pre-commit

and you’re done! It will run every time before you commit, and prevent
and you’re done! It will run every time before you commit and prevent
you from committing if the code has any errors.
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ As a User
coala allows you to simply check your code against certain quality
requirements. The checking routines are named **Bears** in coala. You
can easily define a simple project file to check your project with all
bears either shipped with coala or ones you found in the internet and
bears either shipped with coala or ones you found on the internet and
trust.

As a Developer
Expand Down