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
Comments
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. |
@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 |
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. |
Introduced a note in Writing_Native_Bears.rst and a reminder for developer in Writing_Linter_Bears.rst file. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
@li-boxuan can you please review this commit. this is good to go or should i make change? |
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Fixes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Close coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297
Added a note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297
Added note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297
Added note in Writing_Native_Bears.rst and a reminder for developers in Writing_Linter_Bears.rst files. Closes coala#5297
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
The text was updated successfully, but these errors were encountered: