summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulthep Nandakwang <julthep@nandakwang.com>2022-06-25 02:12:19 +0700
committerGitHub <noreply@github.com>2022-06-24 21:12:19 +0200
commit163a50c01a0f77a70dd96fd0be08350d77abc58a (patch)
tree8487b63ceae750365ceb3630e6a4f50dd0b08152
parent57e0ee596e8e6424676a9b5953c5299808fc023b (diff)
downloadpylint-git-163a50c01a0f77a70dd96fd0be08350d77abc58a.tar.gz
Add documentation examples for `invalid-sequence-index` (#7029)
Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
-rw-r--r--doc/data/messages/i/invalid-sequence-index/bad.py2
-rw-r--r--doc/data/messages/i/invalid-sequence-index/details.rst2
-rw-r--r--doc/data/messages/i/invalid-sequence-index/good.py3
3 files changed, 5 insertions, 2 deletions
diff --git a/doc/data/messages/i/invalid-sequence-index/bad.py b/doc/data/messages/i/invalid-sequence-index/bad.py
new file mode 100644
index 000000000..f153503b9
--- /dev/null
+++ b/doc/data/messages/i/invalid-sequence-index/bad.py
@@ -0,0 +1,2 @@
+fruits = ['apple', 'banana', 'orange']
+print(fruits['apple']) # [invalid-sequence-index]
diff --git a/doc/data/messages/i/invalid-sequence-index/details.rst b/doc/data/messages/i/invalid-sequence-index/details.rst
index ab8204529..98f14845e 100644
--- a/doc/data/messages/i/invalid-sequence-index/details.rst
+++ b/doc/data/messages/i/invalid-sequence-index/details.rst
@@ -1 +1 @@
-You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ !
+Be careful with [True] or [False] as sequence index, since True is represnted as 1 and False as 0, so it will work.
diff --git a/doc/data/messages/i/invalid-sequence-index/good.py b/doc/data/messages/i/invalid-sequence-index/good.py
index c40beb573..04bdf3ffd 100644
--- a/doc/data/messages/i/invalid-sequence-index/good.py
+++ b/doc/data/messages/i/invalid-sequence-index/good.py
@@ -1 +1,2 @@
-# This is a placeholder for correct code for this message.
+fruits = ['apple', 'banana', 'orange']
+print(fruits[0])