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.

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

added a doc string to get-list-details function #240

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

Conversation

Olatundeawo
Copy link

What type of PR is this?

Check all applicable

  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test

Related Issue :

#219

What does this PR do ?

The essence of this pull request lies in fortifying the documentation for the get_list_details endpoint by embedding a detailed docstring. This docstring delves into the intricacies of the endpoint, elucidating its overarching purpose, input parameters, output composition, and potential error scenarios. Furthermore, it includes an illustrative response snippet to elucidate the expected outcome.

Consideration :

I take into consideration:

Prioritizing clarity and comprehensiveness in the documentation to facilitate understanding of the endpoint's functionality and behavior.

How to test ?

To test this enhancement:

Visist http://127.0.0.1:8000/v1/docs

@kshitijrajsharma
Copy link
Member

Thanks for the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants