coala/docs: Add position number convention #5909

bharatpurohit97 · 2018-12-02T13:23:45Z

Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

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:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use corobo mark wip <URL> to get it out
of the review queue.

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

docs/Developers/Writing_Linter_Bears.rst

CLiu13 · 2018-12-03T02:37:26Z

docs/Developers/Writing_Linter_Bears.rst

@@ -144,6 +144,10 @@ that is printed out.

 For the exact list of named groups ``@linter`` recognizes, see the `API
 documentation <https://api.coala.io/en/latest/>`__.
+Pylint uses 0-based column convention and 1-based line convention.
+We need to map linter's convention to coala's, please refer to


add the between map and linter's

CLiu13 · 2018-12-03T02:38:38Z

docs/Developers/Writing_Linter_Bears.rst

@@ -144,6 +144,10 @@ that is printed out.

 For the exact list of named groups ``@linter`` recognizes, see the `API
 documentation <https://api.coala.io/en/latest/>`__.
+Pylint uses 0-based column convention and 1-based line convention.
+We need to map linter's convention to coala's, please refer to


add so between comma and please

CLiu13 · 2018-12-03T02:40:48Z

docs/Developers/Writing_Native_Bears.rst

@@ -597,5 +597,7 @@ For example, let's make an aspect bear named SpellingCheckBear.
                        message='Wrong spelling in word `{}`'.format(word),
                        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 <https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers>`__.


Coala should not be capitalized

CLiu13 · 2018-12-03T02:41:04Z

docs/Developers/Writing_Native_Bears.rst

@@ -597,5 +597,7 @@ For example, let's make an aspect bear named SpellingCheckBear.
                        message='Wrong spelling in word `{}`'.format(word),
                        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 <https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers>`__.


some linter -> some linters

CLiu13 · 2018-12-03T02:42:45Z

docs/Developers/Writing_Native_Bears.rst

@@ -597,5 +597,7 @@ For example, let's make an aspect bear named SpellingCheckBear.
                        message='Wrong spelling in word `{}`'.format(word),
                        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 <https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers>`__.


add so between comma and please

li-boxuan · 2018-12-03T04:10:36Z

docs/Developers/Writing_Native_Bears.rst

@@ -597,5 +597,7 @@ For example, let's make an aspect bear named SpellingCheckBear.
                        message='Wrong spelling in word `{}`'.format(word),
                        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 <https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers>`__.


Why let people refer to linter bear doc? @linter is only for linter bears, and that does not help developers handle the situation in native bears.
Btw, you should use relative link when you refer to some other doc.

li-boxuan · 2018-12-03T04:14:35Z

docs/Developers/Writing_Linter_Bears.rst

@@ -144,6 +144,10 @@ that is printed out.

 For the exact list of named groups ``@linter`` recognizes, see the `API
 documentation <https://api.coala.io/en/latest/>`__.
+Pylint uses 0-based column convention and 1-based line convention.


Add a reminder here is not very useful IMO. And the reminder does not bring any new information.
See #5297 (comment)

docs/Developers/Writing_Linter_Bears.rst

docs/Developers/Writing_Native_Bears.rst

docs/Developers/Writing_Linter_Bears.rst

frextrite · 2018-12-11T08:56:34Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,9 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

+This is reminder for developers that they need to do research on linter bear,


This is a reminder my two cents.

akshatkarani · 2018-12-13T07:56:56Z

@bharatpurohit97 This is not a bug, use closes instead of fixes.

utkarsh2102

Comments inline.
As @akshatkarani mentioned, please change Fixes to Closes.

utkarsh2102 · 2018-12-13T11:07:59Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,9 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

+This is reminder for developers that they need to do research on linter bear,


As @frextrite suggested, it should be a reminder.
Plus, how about ... to do a proper research on ...?

utkarsh2102 · 2018-12-13T11:09:15Z

docs/Developers/Writing_Native_Bears.rst

@@ -598,4 +598,11 @@ 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


There should be a comma after i.e., like: i.e.,.

utkarsh2102 · 2018-12-13T11:10:18Z

docs/Developers/Writing_Native_Bears.rst

+
+    coala uses 1-based line & column convention, i.e. the first line
+    and first column are 1. However, some linters use 0-based convention.
+    For example ``pylint`` uses 1-based line convention and 0-based column


Using a comma after For example would make it look better.

gitmate-bot · 2018-12-14T10:47:53Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,9 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

+This is a reminder for developers that they need to do a proper research on linter bear,


Line is longer than allowed. (88 > 80)

Origin: LineLengthBear, Section: docs.

gitmate-bot · 2018-12-14T11:08:43Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

+This is a reminder for developers that they need to do a proper research on 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst +++ b/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst @@ -251,7 +251,7 @@ normalize_column_numbers = True, ...) -This is a reminder for developers that they need to do a proper research on +This is a reminder for developers that they need to do a proper research on linter bear, ensure the convention and ideally write tests to ensure that behaviour.

gitmate-bot · 2018-12-14T11:08:43Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

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


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst +++ b/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst @@ -252,7 +252,7 @@ ...) This is a reminder for developers that they need to do a proper research on -linter bear, ensure the convention and ideally write tests to ensure that +linter bear, ensure the convention and ideally write tests to ensure that behaviour. Suggest Corrections Using the ``corrected`` and ``unified-diff`` Output Formats

gitmate-bot · 2018-12-14T11:20:17Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

+This is a reminder for developers that they need to do a proper research on 


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst +++ b/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst @@ -251,7 +251,7 @@ normalize_column_numbers = True, ...) -This is a reminder for developers that they need to do a proper research on +This is a reminder for developers that they need to do a proper research on linter bear, ensure the convention and ideally write tests to ensure that behaviour.

gitmate-bot · 2018-12-14T11:20:18Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

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


Line contains following spacing inconsistencies:

Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst +++ b/tmp/tmps0l_00tr/docs/Developers/Writing_Linter_Bears.rst @@ -252,7 +252,7 @@ ...) This is a reminder for developers that they need to do a proper research on -linter bear, ensure the convention and ideally write tests to ensure that +linter bear, ensure the convention and ideally write tests to ensure that behaviour. Suggest Corrections Using the ``corrected`` and ``unified-diff`` Output Formats

bharatpurohit97 · 2018-12-14T12:06:43Z

@utkarsh2102 please re-review.

utkarsh2102

A minor change as suggested.
Else, looks good.

utkarsh2102 · 2018-12-14T15:02:51Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

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


Should be bears, no? 😅

i guess they should research particularly on linter bear

To be more accurate, this should be linter instead of linter bear.

li-boxuan · 2019-01-16T06:40:56Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

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


To be more accurate, this should be linter instead of linter bear.

li-boxuan · 2019-01-16T06:41:45Z

docs/Developers/Writing_Linter_Bears.rst

@@ -251,6 +251,10 @@ We need to map that to coala's convention as follows:
            normalize_column_numbers = True,
            ...)

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


Use .. note:: here

li-boxuan · 2019-01-16T06:42:35Z

docs/Developers/Writing_Native_Bears.rst

+
+    coala uses 1-based line & column convention, i.e., the first line
+    and first column are 1. However, some linters use 0-based convention.
+    For example, ``pylint`` uses 1-based line convention and 0-based column


This is a bad example, as pylint is a linter, which has nothing to do with writing a native bear.
You might want to find an example among existing native bears

I found, there are some bears in coala like - PyLintBear , CheckstyleBear ,StylelintBear . they are normalized, but they all are linter bears.
@li-boxuan is there any native bear that use 0 based convention. Btw i removed linter example.

jayvdb · 2019-02-04T01:55:49Z

docs/Developers/Writing_Native_Bears.rst

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


"linters" is not relevant for native bears where the Result objects are created in coala, and the Result constructor will raise an exception if '0' are given (and due to our 100% test coverage policy, all Result constructors will be tested).

Added note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297

bharatpurohit97 · 2019-02-16T18:14:13Z

@jayvdb is it good to go now? please review.

gitmate-bot added process/pending review size/XS area/documentation difficulty/low labels Dec 2, 2018

gitmate-bot assigned bharatpurohit97 Dec 2, 2018

gitmate-bot reviewed Dec 2, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

gitmate-bot reviewed Dec 2, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 185a852 to 0c7bbd1 Compare December 2, 2018 13:36

gitmate-bot reviewed Dec 2, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

gitmate-bot reviewed Dec 2, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 0c7bbd1 to 8592846 Compare December 2, 2018 14:10

CLiu13 reviewed Dec 3, 2018

View reviewed changes

li-boxuan added process/wip and removed process/pending review labels Dec 3, 2018

li-boxuan reviewed Dec 3, 2018

View reviewed changes

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 8592846 to 19bedcc Compare December 4, 2018 12:53

gitmate-bot added process/pending review and removed process/wip labels Dec 4, 2018

gitmate-bot reviewed Dec 4, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

gitmate-bot reviewed Dec 4, 2018

View reviewed changes

docs/Developers/Writing_Native_Bears.rst Outdated Show resolved Hide resolved

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 19bedcc to 0057da0 Compare December 4, 2018 13:12

gitmate-bot reviewed Dec 4, 2018

View reviewed changes

docs/Developers/Writing_Native_Bears.rst Outdated Show resolved Hide resolved

gitmate-bot reviewed Dec 4, 2018

View reviewed changes

docs/Developers/Writing_Linter_Bears.rst Outdated Show resolved Hide resolved

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 0057da0 to 9f20158 Compare December 4, 2018 13:26

subhaminion approved these changes Dec 8, 2018

View reviewed changes

frextrite approved these changes Dec 11, 2018

View reviewed changes

utkarsh2102 suggested changes Dec 13, 2018

View reviewed changes

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 9f20158 to 5af9197 Compare December 14, 2018 10:45

gitmate-bot reviewed Dec 14, 2018

View reviewed changes

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 5af9197 to 3d56f6c Compare December 14, 2018 11:05

gitmate-bot reviewed Dec 14, 2018

View reviewed changes

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 3d56f6c to 9f5da04 Compare December 14, 2018 11:19

gitmate-bot reviewed Dec 14, 2018

View reviewed changes

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 9f5da04 to 250b6ec Compare December 14, 2018 11:23

utkarsh2102 suggested changes Dec 14, 2018

View reviewed changes

shashank-b approved these changes Dec 15, 2018

View reviewed changes

li-boxuan requested changes Jan 16, 2019

View reviewed changes

li-boxuan added process/wip and removed process/pending review labels Jan 16, 2019

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from 250b6ec to a676fea Compare January 20, 2019 15:31

gitmate-bot added process/pending review and removed process/wip labels Jan 20, 2019

jayvdb requested changes Feb 4, 2019

View reviewed changes

jayvdb added process/wip and removed process/pending review labels Feb 4, 2019

coala/docs: Add position number convention

a02f4fc

Added note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297

bharatpurohit97 force-pushed the patch#5297-positionnumber branch from a676fea to a02f4fc Compare February 16, 2019 10:03

gitmate-bot added process/pending review and removed process/wip labels Feb 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

coala/docs: Add position number convention #5909

coala/docs: Add position number convention #5909

bharatpurohit97 commented Dec 2, 2018

CLiu13 Dec 3, 2018

CLiu13 Dec 3, 2018

CLiu13 Dec 3, 2018

CLiu13 Dec 3, 2018

CLiu13 Dec 3, 2018

li-boxuan Dec 3, 2018

bharatpurohit97 Dec 4, 2018

li-boxuan Dec 3, 2018

frextrite Dec 11, 2018

akshatkarani commented Dec 13, 2018

utkarsh2102 left a comment •

edited

utkarsh2102 Dec 13, 2018

utkarsh2102 Dec 13, 2018

utkarsh2102 Dec 13, 2018

gitmate-bot Dec 14, 2018

gitmate-bot Dec 14, 2018

gitmate-bot Dec 14, 2018

gitmate-bot Dec 14, 2018

gitmate-bot Dec 14, 2018

bharatpurohit97 commented Dec 14, 2018

utkarsh2102 left a comment

utkarsh2102 Dec 14, 2018

bharatpurohit97 Dec 14, 2018

li-boxuan Jan 16, 2019

li-boxuan Jan 16, 2019

li-boxuan Jan 16, 2019

li-boxuan Jan 16, 2019

bharatpurohit97 Jan 20, 2019

jayvdb Feb 4, 2019

bharatpurohit97 commented Feb 16, 2019

coala/docs: Add position number convention #5909

Are you sure you want to change the base?

coala/docs: Add position number convention #5909

Conversation

bharatpurohit97 commented Dec 2, 2018

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akshatkarani commented Dec 13, 2018

utkarsh2102 left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharatpurohit97 commented Dec 14, 2018

utkarsh2102 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bharatpurohit97 commented Feb 16, 2019

utkarsh2102 left a comment •

edited