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

Documentation, Docstrings and Readme #48

Open
mayureshagashe2105 opened this issue Oct 27, 2022 · 0 comments · Fixed by #63, #65, #64 or #67
Open

Documentation, Docstrings and Readme #48

mayureshagashe2105 opened this issue Oct 27, 2022 · 0 comments · Fixed by #63, #65, #64 or #67
Labels
ContributionsWelcome Contributions are welcome from the community documentation Improvements or additions to documentation Priority-2 Priority-2

Comments

@mayureshagashe2105
Copy link
Collaborator

mayureshagashe2105 commented Oct 27, 2022 •
edited by HemanthSai7
Loading

What's the problem this feature will solve?

  1. It will improve the code readability for the users, and contributors, and also will depict the thought process behind a particular piece of code and the authors' intentions.
  2. Create MkDocs and FastAPI style Docs
@mayureshagashe2105 mayureshagashe2105 added the documentation Improvements or additions to documentation label Oct 27, 2022
@mayureshagashe2105 mayureshagashe2105 added Priority-1 Will be prioritize Priority-2 Priority-2 and removed Priority-1 Will be prioritize labels Oct 30, 2022
@mayureshagashe2105 mayureshagashe2105 mentioned this issue Nov 6, 2022
Merged
@HemanthSai7 HemanthSai7 reopened this Nov 6, 2022
This was linked to pull requests Nov 7, 2022
Documentation #65
Merged
Documentation #64
Merged
CREATE README #67
Merged
@mayureshagashe2105 mayureshagashe2105 added the ContributionsWelcome Contributions are welcome from the community label Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ContributionsWelcome Contributions are welcome from the community documentation Improvements or additions to documentation Priority-2 Priority-2
Projects
None yet
Milestone
No milestone
2 participants
@HemanthSai7 @mayureshagashe2105