refactoring code and updating changelog (#60)

Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com> Signed-off-by: Deepak Raj <54245038+codePerfectPlus@users.noreply.github.com>
codeperfectplus · Jan 20, 2023 · 82cdff6 · 82cdff6
1 parent 4f6d7fa
commit 82cdff6
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file. The format
 
 ## Changelog
 
-## [V3.0.0] - Major Release
+## [V3.0.2] - Minor Release - 
+
+- [x] Updating API Documentation
+
+## [V3.0.1] - Minor Release - 18-11-2022
+
+- [x] Code refactor for better readability
+- [x] Link updated for pypi website 
+## [V3.0.0] - Major Release - 09-11-2022
 
 - [x] Function names changed
 - [x] Gender can be passed as a parameter

diff --git a/random_profile/api.py b/random_profile/api.py
@@ -29,7 +29,8 @@
 
 
 @app.get("/")
-def index():
+def home():
+    """ just a home page """
     return metadata
 
 

diff --git a/random_profile/enums/gender.py b/random_profile/enums/gender.py
@@ -1,7 +1,7 @@
 from enum import Enum
 
 
-# class syntax
 class Gender(Enum):
+    """ Gender Enum Class """
     MALE = "Male"
     FEMALE = "Female"