Merge pull request #36 from psobolewskiPhD/fomartting

Formatting with ruff and update the docstring in the text

Author: psobolewskiPhD

arrays/arrays.py

@@ -16,7 +16,6 @@ def subtract_arrays(x, y):
 
 def multiply_arrays(x, y):
     """TODO: Write this function."""
-
     pass
 
 

arrays/completed/arrays_completed.py

@@ -1,6 +1,5 @@
 def add_arrays(x, y):
-    """
-    Add two lists element-wise.
+    """Add two lists element-wise.
 
     Parameters
     ----------
@@ -18,6 +17,7 @@ def add_arrays(x, y):
     --------
     >>> add_arrays([1, 4, 5], [4, 3, 5])
     [5, 7, 10]
+
     """
     if not isinstance(x, list) or not isinstance(y, list):
         raise TypeError("arguments should be arrays")
@@ -32,8 +32,7 @@ def add_arrays(x, y):
 
 
 def subtract_arrays(x, y):
-    """
-    Subtract two lists element-wise.
+    """Subtract two lists element-wise.
 
     Parameters
     ----------
@@ -51,6 +50,7 @@ def subtract_arrays(x, y):
     --------
     >>> subtract_arrays([4, 7, 5], [2, 3, 5])
     [2, 4, 0]
+
     """
     if not isinstance(x, list) or not isinstance(y, list):
         raise TypeError("arguments should be arrays")
@@ -64,8 +64,7 @@ def subtract_arrays(x, y):
 
 
 def multiply_arrays(x, y):
-    """
-    Multiply two lists element-wise.
+    """Multiply two lists element-wise.
 
     Parameters
     ----------
@@ -83,6 +82,7 @@ def multiply_arrays(x, y):
     --------
     >>> multiply_arrays([1, 4, 5], [4, 3, 5])
     [4, 12, 25]
+
     """
     if not isinstance(x, list) or not isinstance(y, list):
         raise TypeError("arguments should be arrays")
@@ -96,8 +96,7 @@ def multiply_arrays(x, y):
 
 
 def divide_arrays(x, y):
-    """
-    Divide two lists element-wise.
+    """Divide two lists element-wise.
 
     Parameters
     ----------
@@ -115,6 +114,7 @@ def divide_arrays(x, y):
     --------
     >>> divide_arrays([6, 4, 5], [4, 2, 5])
     [1.5, 2, 1]
+
     """
     if not isinstance(x, list) or not isinstance(y, list):
         raise TypeError("arguments should be arrays")

arrays/completed/test_arrays_completed.py

@@ -63,7 +63,7 @@ def test_divide_arrays(a, b, expect):
     [
         ([1, 2], [1, 2, 3], ValueError),
         (1, "a", TypeError),
-    ]
+    ],
 )
 def test_add_arrays_errors(a, b, error):
     with pytest.raises(error):
@@ -75,7 +75,7 @@ def test_add_arrays_errors(a, b, error):
     [
         ([1, 2], [1, 2, 3], ValueError),
         (1, "a", TypeError),
-    ]
+    ],
 )
 def test_subtract_arrays_errors(a, b, error):
     with pytest.raises(error):
@@ -87,7 +87,7 @@ def test_subtract_arrays_errors(a, b, error):
     [
         ([1, 2], [1, 2, 3], ValueError),
         (1, "a", TypeError),
-    ]
+    ],
 )
 def test_multiply_arrays_errors(a, b, error):
     with pytest.raises(error):
@@ -100,7 +100,7 @@ def test_multiply_arrays_errors(a, b, error):
         ([1, 2], [1, 2, 3], ValueError),
         (1, "a", TypeError),
         ([1, 2, 3], [0, 2, 3], ZeroDivisionError),
-    ]
+    ],
 )
 def test_divide_arrays_errors(a, b, error):
     with pytest.raises(error):

docstrings.md

@@ -23,8 +23,8 @@
 10. Now, put all the information you got together and write docstrings for the functions we have in `arrays.py`! As an example, I am adding an example docstring for `add_arrays()` below:
 
     ```python
-        """
-        This function adds together each element of the two passed lists.
+    def add_arrays(x, y):
+        """This function adds together each element of the two passed lists.
 
         Parameters
         ----------
@@ -42,6 +42,7 @@
         --------
         >>> add_arrays([1, 4, 5], [4, 3, 5])
         [5, 7, 10]
+        
         """
     ```
     Note the underscores and line spacing in the sections; those are part of the `numpy` docstring style!
@@ -57,4 +58,6 @@ My go-to is [`Ruff`](https://docs.astral.sh/ruff/), a fast Python linter (and fo
 
 4. In general, it is a good idea to do a Ruff pass on your code before committing or merging it! Tip: you can also run `ruff check --fix` to automatically fix some of the issues it finds.
 
-5. Finally, you can also use `ruff` as a formatting tool, similar to `black`. You can run `ruff format` on your repository directory to automatically reformat your code to follow PEP 8 guidelines. This is a great way to ensure that your code is consistently formatted and adheres to best practices. This can make it easier to avoid merge conflicts due to formatting/whitespace differences, however **if you are working on a shared codebase, make sure to check the contribution guide before running any autoformatting tools.**
+5. You can specify extra rules using `--select`, for example `ruff check --select D` will only check for docstring related issues, while `I` will look at import sorting. You can also ignore specific rules using `--ignore`, for example `ruff check --ignore E501` will ignore line length issues.
+
+6. Finally, you can also use `ruff` as a formatting tool, similar to `black`. You can run `ruff format` on your repository directory to automatically reformat your code to follow PEP 8 guidelines. This is a great way to ensure that your code is consistently formatted and adheres to best practices. This can make it easier to avoid merge conflicts due to formatting/whitespace differences, however **if you are working on a shared codebase, make sure to check the contribution guide before running any autoformatting tools.**