Refined the docstring for the get_task_status endpoint to improve cla… #232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rity and completeness. Added detailed descriptions for parameters, possible status values, and example responses to facilitate better understanding by developers.
|
Thank you for the PR ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR enhances the documentation for tasks.py. The documentation has been formatted using Black formatter.
Link to the corresponding GitHub issue: This resolve #219
Consideration:
While developing this PR, I considered the clarity and completeness of the documentation. I aimed to provide detailed information about each endpoint to assist users in understanding how to interact with the API effectively.
How to test?
visit http://127.0.0.1:8000/v1/docs to view API endpointsWhat does this PR do?