doc: Update tasks.py improve docstring clarity and completeness #2
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
This commit enhances the docstrings to improve clarity for get_list_details endpoint.
|
Have created a pull request. |
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 pull request adds a detailed docstring to the retrieve_task_details endpoint. The docstring provides comprehensive information about the endpoint's functionality, including its purpose, parameters, return value, and potential exceptions. It includes an example response to illustrate the expected output.
It resolve issue hotosm#219
Consideration:
While developing this enhancement, the following considerations were taken into account:
Ensuring clarity and completeness in the documentation to aid in understanding the endpoint's usage and behavior.
Providing an example response to demonstrate the format of the output under different conditions.
How to test?
To test this enhancement:
Visist http://127.0.0.1:8000/v1/docs