Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions analyzer-comments/python/pylint/convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
This code doesn't follow general [Python code style][code style] conventions.
While this type of issue generally doesn't affect the way code _executes_, it can hurt readability or the performance of automated tools such as documentation generators or test runners.

%Q{Instead of:\n\n```python\n#{bad_code}\n```\n}
%Q{Try:\n\n```python\n#{good_code}\n```\n\n}
%Q{Additional information:\n #{related_info}\n}
%{bad_code}
%{good_code}
%{related_info}
%{details}

[code style]: https://www.python.org/dev/peps/pep-0008/
7 changes: 3 additions & 4 deletions analyzer-comments/python/pylint/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

This code has an error or problem that should be addressed.

%Q{Instead of:\n\n```python\n#{bad_code}\n```\n}
%Q{Try:\n\n```python\n#{good_code}\n```\n\n}
%Q{Additional information:\n #{related_info}\n}
%{bad_code}
%{good_code}
%{related_info}
%{details}

6 changes: 3 additions & 3 deletions analyzer-comments/python/pylint/informatonal.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
There is `FIXME`/`TODO`/`XXX` style comment or other "informational" pattern or note in the code.
These tags are often used to annotate places where code is stubbed out but needs work - or to highlight potential design flaws or bugs that need to be addressed in the future.

%Q{Instead of:\n\n```python\n#{bad_code}\n```\n}
%Q{Try:\n\n```python\n#{good_code}\n```\n\n}
%Q{Additional information:\n #{related_info}\n}
%{bad_code}
%{good_code}
%{related_info}
%{details}
6 changes: 3 additions & 3 deletions analyzer-comments/python/pylint/refactor.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ a re-write or refactor.
appears to have one or more patterns that could lead to _future_ bugs or maintenance issues.
Consider taking a closer look at it.

%Q{Instead of:\n\n```python\n#{bad_code}\n```\n}
%Q{Try:\n\n```python\n#{good_code}\n```\n\n}
%Q{Additional information:\n #{related_info}\n}
%{bad_code}
%{good_code}
%{related_info}
%{details}

[code smell]: https://en.wikipedia.org/wiki/Code_smell
7 changes: 3 additions & 4 deletions analyzer-comments/python/pylint/warning.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ There is an issue in the code that could lead to a bug or error in the program.
While this error might not be _severe_, it could lead to more severe issues in the future.
It is recommended the problem be addressed before proceeding further.

%Q{Instead of:\n\n```python\n#{bad_code}\n```\n}
%Q{Try:\n\n```python\n#{good_code}\n```\n\n}
%Q{Additional information:\n #{related_info}\n}
%{bad_code}
%{good_code}
%{related_info}
%{details}