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 for module, class, method and functions #3

Open
NewJerseyStyle opened this issue May 1, 2024 · 3 comments
Open

Documentation for module, class, method and functions #3

NewJerseyStyle opened this issue May 1, 2024 · 3 comments
Assignees
@NewJerseyStyle
Labels
documentation Improvements or additions to documentation
Milestone
First alpha release

Comments

@NewJerseyStyle
Copy link
Owner

Document and docstring should be checked and rendered before merge into main branch
@NewJerseyStyle NewJerseyStyle added the documentation Improvements or additions to documentation label May 1, 2024
@NewJerseyStyle NewJerseyStyle added this to the First alpha release milestone May 1, 2024
@NewJerseyStyle NewJerseyStyle self-assigned this May 1, 2024
@NewJerseyStyle
Copy link
Owner Author

Sphinx NumPy Style Python Docstrings:

@NewJerseyStyle
Copy link
Owner Author

Docstrings added in some of the codes

NewJerseyStyle added a commit that referenced this issue Jun 18, 2024
@NewJerseyStyle
Update db.py resolving issue #3
17271ac
NewJerseyStyle added a commit that referenced this issue Jun 18, 2024
@NewJerseyStyle
Update db.py align with #3 and #6
a1956df
NewJerseyStyle added a commit that referenced this issue Jun 20, 2024
@NewJerseyStyle
Update secure.py adding metadata tags #3
234dfc6
NewJerseyStyle added a commit that referenced this issue Jun 21, 2024
@NewJerseyStyle
Update secure.py all endpoint uses Request Body and add docstr #3
5f4de64 
Request Body based on doc https://fastapi.tiangolo.com/tutorial/body/
Add docstring to all functional endpoints
NewJerseyStyle added a commit that referenced this issue Jun 21, 2024
@NewJerseyStyle
Update secure.py impl Response Model #3 #2
3a7e67b
@NewJerseyStyle
Copy link
Owner Author

Generate docs in release branch before alpha release

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

@NewJerseyStyle NewJerseyStyle

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
First alpha release
Development

When branches are created from issues, their pull requests are automatically linked.

release NewJerseyStyle/LitePolis
1 participant
@NewJerseyStyle