Skip to content
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

Add position number convention to native/linter bear guide #5297

Open
li-boxuan opened this issue Mar 31, 2018 · 6 comments · May be fixed by #5909
Open

Add position number convention to native/linter bear guide #5297

li-boxuan opened this issue Mar 31, 2018 · 6 comments · May be fixed by #5909

Comments

@li-boxuan
Copy link
Member

li-boxuan commented Mar 31, 2018

coala uses one-based row number and one-based column number (see https://api.coala.io/en/latest/coalib.results.html#module-coalib.results.Result). This should also be mentioned in the tutorial.

Linter bear writers should be careful about that convention to avoid inconsistency. IMO this should be updated: http://api.coala.io/en/latest/Developers/Writing_Linter_Bears.html

@gitmate-bot
Copy link
Collaborator

GitMate.io thinks possibly related issues are #33 (add possibility to generate documentation), #127 (documentation), #4353 (Add pdb documentation), #5290 (Documentation: Add guidelines on git merge conflicts), and #681 (Globbing: Add examples to documentation).

@li-boxuan li-boxuan changed the title Add position number convention to documentation Add position number convention to linter bear guide Mar 31, 2018
@jayvdb
Copy link
Member

jayvdb commented Apr 6, 2018

This should be mentioned in both https://github.com/coala/coala/blob/master/docs/Developers/Writing_Linter_Bears.rst and https://github.com/coala/coala/blob/master/docs/Developers/Writing_Native_Bears.rst

@li-boxuan li-boxuan changed the title Add position number convention to linter bear guide Add position number convention to native/linter bear guide Nov 20, 2018
@li-boxuan
Copy link
Member Author

li-boxuan commented Nov 20, 2018

https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers is already mentioned in the linter bear guide, but it would be good to remind developers that they need to be careful about that. They need to do research on linter bear, ensure the convention, and ideally write tests to (partially) ensure that behavior.

@bharatpurohit97
Copy link
Member

@li-boxuan i need some guidance, should i introduce new paragraph in documentation or modify 0 based column convention to 1 based as coala uses 1 based column convention in this -https://coala-api.netlify.com/developers/writing_linter_bears#normalize-line-or-column-numbers

@li-boxuan
Copy link
Member Author

For linter bear, you do not need to introduce a new paragraph, but it would be good to add a reminder. See #5297 (comment)

For native bear, you need to introduce a new paragraph, or a note.

bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Nov 29, 2018
Introduced a note in Writing_Native_Bears.rst and
a reminder for developer in Writing_Linter_Bears.rst file.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Nov 29, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
@bharatpurohit97
Copy link
Member

bharatpurohit97 commented Nov 29, 2018

@li-boxuan can you please review this commit. this is good to go or should i make change?

@bharatpurohit97 bharatpurohit97 linked a pull request Dec 2, 2018 that will close this issue
2 tasks
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 2, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 2, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 4, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 4, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 4, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Fixes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 14, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Close coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 14, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 14, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Dec 14, 2018
Added a note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Jan 20, 2019
Added note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes coala#5297
bharatpurohit97 added a commit to bharatpurohit97/coala that referenced this issue Feb 16, 2019
Added note in Writing_Native_Bears.rst and a reminder
for developers in Writing_Linter_Bears.rst files.

Closes coala#5297
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

5 participants