Merge pull request #90 from jetbrains-academy/sofia/add_docstrings_task

added docstrings task

Author: Geravant

Functions/Docstrings/__init__.py

@@ -0,0 +1,15 @@
+type: edu
+files:
+- name: task.py
+  visible: true
+  placeholders:
+  - offset: 32
+    length: 54
+    placeholder_text: '# TODO: add a docstring here'
+- name: tests/test_task.py
+  visible: false
+- name: __init__.py
+  visible: false
+- name: tests/__init__.py
+  visible: false
+feedback_link: https://docs.google.com/forms/d/e/1FAIpQLSfRlDlldKfuq-cHMNFfHMER61P1PRIan7KG6yp1GvaweDI7GA/viewform?usp=pp_url&entry.2103429047=Functions+/+Docstrings

Functions/Docstrings/task-info.yaml

@@ -0,0 +1,13 @@
+## Docstrings
+
+One-line docstrings are for really obvious cases. Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description. 
+The docstring for a function or method should summarize its behavior and document its arguments, return value(s), side effects, exceptions raised, and restrictions on when it can be called (all if applicable). Optional arguments should be indicated. It should be documented whether keyword arguments are part of the interface.
+
+
+Docstrings should also generally be written for modules, classes and methods definitions (you will learn about these things later on in the course). Read more about docstring conventions in the [Python PEP Guide](https://peps.python.org/pep-0257/).
+
+### Task 
+Add the following docstring to the function defined in the code editor:
+```text
+"""This function adds 1 to each element of the list"""
+```

Functions/Docstrings/task.md

@@ -0,0 +1,11 @@
+def increment_list(mylist):
+    """This function adds 1 to each element of the list"""
+
+    for i in range(len(mylist)):
+        mylist[i] += 1
+
+    return mylist
+
+
+print(increment_list.__doc__)
+print(increment_list([1, 2, 3]))

Functions/Docstrings/task.py

@@ -0,0 +1,12 @@
+import unittest
+
+from task import increment_list
+
+
+class TestCase(unittest.TestCase):
+    def test_doc(self):
+        self.assertNotEqual(increment_list.__doc__, None, msg="Add the docstring to the function.")
+        self.assertEqual(increment_list.__doc__, "This function adds 1 to each element of the list", msg="The "
+                                                                                                         "docstring "
+                                                                                                         "seems to be "
+                                                                                                         "different.")

Functions/Docstrings/tests/__init__.py

@@ -2,6 +2,7 @@ content:
 - Definition
 - Parameters and call arguments
 - Return value
+- Docstrings
 - Default parameters
 - Keyword Arguments
 - Argument Order