New fetures 465900

docs/README.md

@@ -1,10 +1,117 @@
-# Math formulas
-## Area
-- Circle: S = πR²
-- Rectangle: S = ab
-- Square: S = a²
-
-## Perimeter
-- Circle: P = 2πR
-- Rectangle: P = 2a + 2b
-- Square: P = 4a
+
+# Project Documentation
+
+## Общее описание решения
+Этот проект включает в себя набор функций для работы с геометрическими фигурами такими как: прямоугольник, круг, квадрат, треугольник. 
+Для каждой фигуры существуют функции вычисления площади (`area`) и периметра (`perimeter`).
+
+Проект структурирован по файлам, где каждая фигура представлена отдельным модулем:
+
+- `rectangle.py` — работа с прямоугольниками.
+- `circle.py` — работа с кругами.
+- `square.py` — работа с квадратами.
+- `triangle.py` — работа с треугольниками.
+
+---
+
+## Описание функций
+
+### Файл: rectangle.py
+#### 
+```def area(a, b)
+'''Принимает параметры a и b (размеры прямоугольника), и вычисляет его площадь по формуле произведения.'''
+```
+**Пример вызова**:
+```
+area(4, 5)  # Результат: 20
+```
+
+#### 
+```def perimeter(a, b, c, d)
+'''Принимает параметры a, b, c, d - 4 стороны прямоугольника, и вычисляет его периметр по формуле суммы длинн всех сторон'''
+```
+**Пример вызова**:
+```
+perimeter(4, 1, 4, 1)  # Результат: 10
+```
+
+### Файл: square.py
+#### 
+```def area(a)
+'''Принимает параметр a (длинна стороны квадрата), и вычисляет его площадь по формуле, возводя эту сторону в квадрат (все стороны квадрата равны).'''
+```
+**Пример вызова**:
+```
+area(3)  # Результат: 9
+```
+
+#### 
+```def perimeter(a)
+'''Принимает параметр a (длинна стороны квадрата), и вычисляет его периметр, умножая сторону на 4 (т.к. все стороны квадрата равны).'''
+```
+**Пример вызова**:
+```
+perimeter(3)  # Результат: 12
+```
+
+### Файл: triangle.py
+#### 
+```def area(a, h)
+'''Принимает параметры a и h (основание треугольника и его высота соответственно), и вычисляет его площадь по формуле произведения 1/2 основания на высоту.'''
+```
+**Пример вызова**:
+```
+area(4, 3)  # Результат: 6
+```
+
+#### 
+```def perimeter(a, b, c)
+'''Принимает параметры a и b и c (все три измерения треугольника), и вычисляет его периметр как сумму трех сторон'''
+```
+**Пример вызова**:
+```
+perimeter(3, 5, 7)  # Результат: 15
+```
+
+### Файл: circle.py
+#### 
+```import math
+'''Подключает библиотеку math для использования числа pi при вычислениях.'''
+def area(r)
+'''Принимает параметр r (радиус круга), и вычисляет его площадь по формуле произведения квадрата радиуса на число pi.'''
+```
+**Пример вызова**:
+```
+area(4)  # Результат: 16pi
+```
+
+#### 
+```def perimeter(r)
+'''Принимает параметр r - радиус треугольника, и вычисляет его периметр по формуле произведения 2pi на r'''
+```
+**Пример вызова**:
+```
+perimeter(4)  # Результат: 8pi
+```
+
+---
+
+## История изменений проекта
+
+1. **Хэш коммита: 8ba9aeb**  
+Добавлены файлы для вычисления периметра и площади круга и квадрата `circle.py` и `square.py` соответственно.
+
+2. **Хэш коммита: d078c8d**  
+Добавлен изначальный вариант файла docs - описания функционала проекта.
+
+3. **Хэш коммита: 9f6ced6**  
+Добавлен новый файл для вычисления периметра и площади прямоугольника `rectangle.py`.
+
+4. **Хэш коммита: 84200ab**  
+Добавлен новый файл для вычисления периметра и площади треугольника `triangle.py`.
+
+
+5. **Хэш коммита: c9e1736**  
+Была исправлена ошибка в вычислении периметра прямоугольника, файл `rectangle.py`.
+
+---

rectangle.py

@@ -0,0 +1,7 @@
+
+def area(a):
+    return a * b
+
+
+def perimeter(a):
+    return a + b + c + d