Skip to content

Commit

Permalink
.coafile: Use RSTcheckBear and update .coafile
Browse files Browse the repository at this point in the history
Add RSTcheckBear in the .coafile. Fixed all
issues which occured due to addition of
RSTcheckBear in the same PR itself.

Closes coala#4209
  • Loading branch information
mridubhatnagar authored and jayvdb committed Apr 19, 2018
1 parent 1941f5e commit f2b0625
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 18 deletions.
9 changes: 7 additions & 2 deletions .coafile
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ ignore_length_regex = ^.*https?://
[DOCS]
bears = SpaceConsistencyBear, LineLengthBear

files = docs/**/*.rst, CONTRIBUTING.rst, README.rst
files = docs/**/*.rst,*.rst
ignore = docs/API/**
ignore_length_regex = ^.*https?://

Expand All @@ -52,7 +52,7 @@ default_actions = SpaceConsistencyBear: ApplyPatchAction
enabled = False

bears = LanguageToolBear
files = docs/**/*.rst, CONTRIBUTING.rst, README.rst
files = docs/**/*.rst,*.rst
ignore = docs/API/**
languagetool_disable_rules =
EN_QUOTES, # `` for links in rst files
Expand Down Expand Up @@ -117,6 +117,11 @@ files = docs/_static/**.css
bears = reSTLintBear
files = README.rst

[rstcheck]
bears = RSTcheckBear
files = **.rst
ignore = docs/Developers/coala_settings.rst

[text]
bears = SpaceConsistencyBear
files =
Expand Down
23 changes: 13 additions & 10 deletions RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ and the next generation core.
- coala will now output a warning if you specify an editor that is not known.
- The ``noqa`` keyword used by other linters as an ignore keyword is now
supported as a coala ignore keyword.
- ``libclang-py3`` update to 3.4 is known to cause problems for some users. Please
uninstall and reinstall it if coala tells you there is a version mismatch
in ``libclang-py3``.
- ``libclang-py3`` update to 3.4 is known to cause problems for some users.
Please uninstall and reinstall it if coala tells you there is a version
mismatch in ``libclang-py3``.
- ``C#`` now has proper language support and should work with AnnotationBear
and all other bears which require language configuration.

Expand Down Expand Up @@ -193,10 +193,10 @@ the first aspects are already in our source code and that bears can already
associate results with them so future versions of coala will be able to tell
the user a plethora of facts around the type of issue pointed out.

**For users**, we have added a lot of usability improvements as well as for example
the ability to merge patches within one line: if you previously had to run
coala multiple times because of patch conflicts, this is likely not the case
anymore!
**For users**, we have added a lot of usability improvements as well as for
example the ability to merge patches within one line: if you previously had
to run coala multiple times because of patch conflicts, this is likely not
the case anymore!

**As a Bear writer** you now have access to our ``Language`` facilities: they
will give you facts about programming languages that you analyse so you can
Expand Down Expand Up @@ -342,7 +342,8 @@ Below are some of the important changes introduced for this release:
- Bears now have a new ``REQUIREMENTS`` attribute which will be used to
automatically resolve bear dependencies. This includes:

+ Native requirements (from package managers such as ``apt-get``, ``dnf``, ``pacman``, ...)
+ Native requirements
(from package managers such as ``apt-get``, ``dnf``, ``pacman``, ...)
+ Conda requirements
+ Python requirements through ``pip3``
+ ``go`` requirements
Expand All @@ -361,10 +362,12 @@ Below are some of the important changes introduced for this release:
ever before to create external linter based bears for coala!

- A new `ASCIINEMA_URL` attribute has been added to bears. This should
contain an URL to an asciinema video displaying the bear's capabilities in action.
contain an URL to an asciinema video displaying the bear's capabilities in
action.

- Bear results may now have a ``confidence`` parameter: this is supposed to
quantify the confidence, on a scale of 1 to 100, the bear has when flagging results.
quantify the confidence, on a scale of 1 to 100, the bear has when flagging
results.

- A ``deprecate_settings`` decorator has been created to deprecate old,
unsupported bear parameters. Please see
Expand Down
4 changes: 2 additions & 2 deletions docs/Developers/Adding_CI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,15 @@ Codecov
-------

We require 100% test coverage, and to test that we use
`codecov.io <https://codecov.io>`_ which takes data from all other
`codecov.io <https://codecov.io>`__ which takes data from all other
CI to confirm its coverage.
Here are two example reports from coala and coala-bears repository :
https://codecov.io/gh/coala/coala/ and
https://codecov.io/gh/coala/coala-bears/. Once you follow the
instructions here, you will have identical reports for your forked
repository.

1. Go to `codecov.io <https://codecov.io>`_ and sign up using your
1. Go to `codecov.io <https://codecov.io>`__ and sign up using your
GitHub account.
2. Click on your username, and that will take you to a page where
the repositories that use codecov are listed.
Expand Down
2 changes: 1 addition & 1 deletion docs/Developers/Development_Setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ in your current directory, as coala only works for Python >= 3.4.4
(coala-venv)$ deactivate # to exit the environment

- After this, you can start
`installing from git <https://api.coala.io/en/latest/Developers/Development_Setup.html#id1>`_.
`installing from git <https://api.coala.io/en/latest/Developers/Development_Setup.html#id1>`__.

Repositories
------------
Expand Down
2 changes: 0 additions & 2 deletions docs/Developers/Newcomers_Guide.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _newcomer-guide:

Welcome to the Newcomers' Guide!
================================

Expand Down
2 changes: 1 addition & 1 deletion docs/Developers/Writing_Linter_Bears.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ integrate linters in your bears.
Bear. If you want to write a global linter Bear, for a tool that does not
run once for each file, but only once for the whole project, you can still
go through the steps and then read about the differences of global linter
Bears at :ref:`global_bears`.
Bears at `global_bears`_.

Why is This Useful?
-------------------
Expand Down

0 comments on commit f2b0625

Please sign in to comment.