Skip to content

Commit

Permalink
coala/docs: Add position number convention
Browse files Browse the repository at this point in the history
Added note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes #5297
  • Loading branch information
bharatpurohit97 committed Jan 20, 2019
1 parent 0636e9b commit a676fea
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Developers/Writing_Linter_Bears.rst
Expand Up @@ -251,6 +251,12 @@ We need to map that to coala's convention as follows:
normalize_column_numbers = True,
...)

.. note::

This is a reminder for developers that they need to do a proper research on
linter, ensure the convention and ideally write tests to ensure that

This comment has been minimized.

Copy link
@KVGarg

KVGarg Feb 1, 2019

Contributor

after comma maybe this wording will look better and ensure the convention behaviour while writing tests.

behaviour.

Suggest Corrections Using the ``corrected`` and ``unified-diff`` Output Formats
-------------------------------------------------------------------------------

Expand Down
6 changes: 6 additions & 0 deletions docs/Developers/Writing_Native_Bears.rst
Expand Up @@ -598,4 +598,10 @@ For example, let's make an aspect bear named SpellingCheckBear.
aspect=DictionarySpelling('py'),
)
.. note::

coala uses 1-based line & column convention, i.e., the first line
and first column are 1. However, some linters use 0-based convention.
We need to map these conventions.

.. _main tutorial: https://docs.coala.io/en/latest/Users/Tutorial.html

0 comments on commit a676fea

Please sign in to comment.