From e75173b876a0b52d5f9d27c7c94999cb3e8bcb73 Mon Sep 17 00:00:00 2001 From: Vishal Vaibhav Date: Sun, 13 Feb 2022 18:37:31 +0530 Subject: [PATCH] Added documentation.md And Changed Some Function Names --- Documentation.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ module.py | 4 ++-- 2 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 Documentation.md diff --git a/Documentation.md b/Documentation.md new file mode 100644 index 0000000..8151b44 --- /dev/null +++ b/Documentation.md @@ -0,0 +1,51 @@ +# **Installation** +## **From Terminal** +#### 1. use command `pip3 install easyPythonPi` +#### 2. import using `From easyPythonpi.easyPythonpi import*` + +## **Functions in _easyPythonPi_ Library** + +### **_add(x, y)_** + +#### \*For adding two numbers + +## **_sub(x, y)_** + +#### \* For subtracting two numbers + +## **_div(x, y)_** + +#### \* For dividing two numbers + +#### \* This will return quotient + +## **_mod(x, y)_** + +#### \* For dividing two numbers + +#### \* This will return reminder + +## **_factorial(n)_** + +#### \* This will give factorial of the number i.e n + +#### \* eg: n = 3 +#### 3 x 2 x 1 = 6 + +## **_AreaCircle(r)_** + +#### \* Will give area of circle +#### \* Takes radius as parameter + +## **_PerimeterCircle(r)_** + +#### \* Will give the perimeter of circle +#### \* Takes radius as parameter + +## **_fibonacci(n)_** + +#### \* **[Click To Learn About Fibonacci Series In Python]**(https://www.programiz.com/python-programming/examples/fibonacci-sequence#:~:text=A%20Fibonacci%20sequence%20is%20the,n%2D2th%20term.) + +## **_sort(list)_** + +#### \* For sorting(i.e ascending order) [ bubble sort ] diff --git a/module.py b/module.py index 8ec1185..d5bc653 100644 --- a/module.py +++ b/module.py @@ -24,11 +24,11 @@ def factorial(n): # To find the factorial of 2 numbers # single line to find factorial return 1 if (n == 1 or n == 0) else n * factorial(n - 1) -def Area_circle(r): # To find the area of a circle using the radius r +def AreaCircle(r): # To find the area of a circle using the radius r PI = 3.142 return PI * (r * r) -def Perimeter_circle(r): # To find the perimeter of a circle using the radius r +def PerimeterCircle(r): # To find the perimeter of a circle using the radius r PI = 3.142 return 2 * PI * r