diff --git a/docs/Developers/Writing_Linter_Bears.rst b/docs/Developers/Writing_Linter_Bears.rst index 53c3f38b3e..6c260895e3 100644 --- a/docs/Developers/Writing_Linter_Bears.rst +++ b/docs/Developers/Writing_Linter_Bears.rst @@ -145,6 +145,11 @@ that is printed out. For the exact list of named groups ``@linter`` recognizes, see the `API documentation `__. +Pylint uses 0-based column convention and 1-based line convention. +We need to map linter's convention to coala's, please refer to +`Normalize line or Column convention `__. + Please refer to `Python3 re module `_ and `Dive into python `_ for information about regular expressions. diff --git a/docs/Developers/Writing_Native_Bears.rst b/docs/Developers/Writing_Native_Bears.rst index 879ff9348e..4b84bde678 100644 --- a/docs/Developers/Writing_Native_Bears.rst +++ b/docs/Developers/Writing_Native_Bears.rst @@ -598,4 +598,7 @@ 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 linter use 0-based convention. For example ``pylint`` uses 1-based line convention and 0-based column convention. We need to map these conventions, please refer to `Normalize line or Column convention `__. + .. _main tutorial: https://docs.coala.io/en/latest/Users/Tutorial.html