Documentation Lab2

circle.py

@@ -1,10 +1,25 @@
 import math
 
-
 def area(r):
-    return math.pi * r * r
+    """
+    Возвращает площадь круга.
 
+    Параметры:
+    r (int, float): радиус круга.
+
+    Возвращаемое значение:
+    float: площадь круга.
+    """
+    return math.pi * r * r
 
 def perimeter(r):
-    return 2 * math.pi * r
+    """
+    Возвращает периметр (длину окружности) круга.
+
+    Параметры:
+    r (int, float): радиус круга.
 
+    Возвращаемое значение:
+    float: длина окружности.
+    """
+    return 2 * math.pi * r

docs/documentation.md

@@ -0,0 +1,57 @@
+
+# Документация проекта
+
+## Общее описание
+Этот проект включает функции для вычисления площади и периметра различных геометрических фигур, таких как прямоугольник, треугольник, квадрат и круг.
+
+## Описание функций с примерами вызова
+
+### Прямоугольник (`rectangle.py`)
+- `area(a, b)`: Возвращает площадь прямоугольника.
+  ```python
+  area(5, 3)  # Пример вызова
+  ```
+- `perimeter(a, b)`: Возвращает периметр прямоугольника.
+  ```python
+  perimeter(5, 3)  # Пример вызова
+  ```
+
+### Треугольник (`triangle.py`)
+- `area(a, h)`: Возвращает площадь треугольника.
+  ```python
+  area(4, 6)  # Пример вызова
+  ```
+- `perimeter(a, b, c)`: Возвращает периметр треугольника.
+  ```python
+  perimeter(3, 4, 5)  # Пример вызова
+  ```
+
+### Квадрат (`square.py`)
+- `area(a)`: Возвращает площадь квадрата.
+  ```python
+  area(4)  # Пример вызова
+  ```
+- `perimeter(a)`: Возвращает периметр квадрата.
+  ```python
+  perimeter(4)  # Пример вызова
+  ```
+
+### Круг (`circle.py`)
+- `area(r)`: Возвращает площадь круга.
+  ```python
+  area(5)  # Пример вызова
+  ```
+- `perimeter(r)`: Возвращает периметр круга.
+  ```python
+  perimeter(5)  # Пример вызова
+  ```
+
+## История изменений
+- Хэш коммита: Описание изменений
+  - `8b3343b`: Начальная версия функций.
+  - `d078c8d`: Добавлены тестовые примеры и документация.
+  - `4e3d6a6`: Добавлен rectangle.py с вычислениями площади и периметра.
+  - `8004268`: Добавлен triangle.py с вычислениями площади и периметра.
+  - `8b3343b`: Исправлены расчеты периметра в rectangle.py.
+  - `6251ab6`: Добавлены unit-tests.
+  - `5dcde4f`: Добавление автоматических проверок под пушы.

rectangle.py

@@ -0,0 +1,25 @@
+def area(a, b):
+    """
+    Возвращает площадь прямоугольника.
+
+    Параметры:
+    a (int, float): первая сторона прямоугольника.
+    b (int, float): вторая сторона прямоугольника.
+
+    Возвращаемое значение:
+    float: площадь прямоугольника.
+    """
+    return a * b
+
+def perimeter(a, b):
+    """
+    Возвращает периметр прямоугольника.
+
+    Параметры:
+    a (int, float): первая сторона прямоугольника.
+    b (int, float): вторая сторона прямоугольника.
+
+    Возвращаемое значение:
+    float: периметр прямоугольника.
+    """
+    return 2 * (a + b)

square.py

@@ -1,7 +1,23 @@
-
 def area(a):
-    return a * a
+    """
+    Возвращает площадь квадрата.
+
+    Параметры:
+    a (int, float): сторона квадрата.
 
+    Возвращаемое значение:
+    float: площадь квадрата.
+    """
+    return a * a
 
 def perimeter(a):
+    """
+    Возвращает периметр квадрата.
+
+    Параметры:
+    a (int, float): сторона квадрата.
+
+    Возвращаемое значение:
+    float: периметр квадрата.
+    """
     return 4 * a

triangle.py

@@ -0,0 +1,27 @@
+def area(a, h):
+    """
+    Возвращает площадь треугольника.
+
+    Параметры:
+    a (int, float): основание треугольника.
+    h (int, float): высота треугольника.
+
+    Возвращаемое значение:
+    float: площадь треугольника.
+    """
+    return a * h / 2
+
+def perimeter(a, b, c):
+    """
+    Возвращает периметр треугольника.
+
+    Параметры:
+    a (int, float): первая сторона треугольника.
+    b (int, float): вторая сторона треугольника.
+    c (int, float): третья сторона треугольника.
+
+    Возвращаемое значение:
+    float: периметр треугольника.
+    """
+    return a * h / 2
+