Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvement/ Documentation added in few modules #27

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improvement/ Documentation added in few modules #27

wants to merge 1 commit into from
+894 −205

Conversation

Nisarg1112
Copy link

Overview

  • This pull request addresses the need for comprehensive code documentation by adding comments to various functions within specific modules. The goal is to enhance the readability and maintainability of the codebase, making it easier for developers to understand the purpose and functionality of each function.

Changes Made

  • Introduces inline comments within the codebase, specifically focusing on function documentation.
  • Comments provide insights into the purpose of each function, expected input parameters, and the intended functionality.
  • Aimed at improving the overall clarity of the code and facilitating collaboration among developers.

Testing

  • No changes have been made to the actual functionality of the code; this PR is focused solely on documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aravindgopall aravindgopall aravindgopall approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Nisarg1112 @aravindgopall