summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulthep Nandakwang <julthep@nandakwang.com>2022-06-24 21:16:44 +0700
committerGitHub <noreply@github.com>2022-06-24 16:16:44 +0200
commitc3a589083568d980957b0478d37a1ac58406f21f (patch)
treee5019653117d0b70d17e637cc211934aa82b4e52
parent25525859af56bc613e7922af9aea57f517d888bd (diff)
downloadpylint-git-c3a589083568d980957b0478d37a1ac58406f21f.tar.gz
Add documentation examples for `init-is-generator` (#7022)
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/init-is-generator/bad.py5
-rw-r--r--doc/data/messages/i/init-is-generator/details.rst1
-rw-r--r--doc/data/messages/i/init-is-generator/good.py11
3 files changed, 15 insertions, 2 deletions
diff --git a/doc/data/messages/i/init-is-generator/bad.py b/doc/data/messages/i/init-is-generator/bad.py
new file mode 100644
index 000000000..37c204ab2
--- /dev/null
+++ b/doc/data/messages/i/init-is-generator/bad.py
@@ -0,0 +1,5 @@
+class Fruit:
+ def __init__(self, worms): # [init-is-generator]
+ yield from worms
+
+apple = Fruit(["Fahad", "Anisha", "Tabatha"])
diff --git a/doc/data/messages/i/init-is-generator/details.rst b/doc/data/messages/i/init-is-generator/details.rst
deleted file mode 100644
index ab8204529..000000000
--- a/doc/data/messages/i/init-is-generator/details.rst
+++ /dev/null
@@ -1 +0,0 @@
-You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ !
diff --git a/doc/data/messages/i/init-is-generator/good.py b/doc/data/messages/i/init-is-generator/good.py
index c40beb573..483cd46c1 100644
--- a/doc/data/messages/i/init-is-generator/good.py
+++ b/doc/data/messages/i/init-is-generator/good.py
@@ -1 +1,10 @@
-# This is a placeholder for correct code for this message.
+class Fruit:
+ def __init__(self, worms):
+ self.__worms = worms
+
+ def worms(self):
+ yield from self.__worms
+
+apple = Fruit(["Fahad", "Anisha", "Tabatha"])
+for worm in apple.worms():
+ pass