Enhance/custom export documentation #3
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.
…tom_request Made endpoint documentation more informative by adding details on exception raised during function execution.
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
process_custom_requestfunction docstring for better readability and comprehension.Detail Summary:
The commit refines the docstring of the
process_custom_requestfunction to provide a more informative overview of its purpose and exception handling. It also includes a link to the relevant issue.Consideration:
While developing, alternative approaches to exception handling and documentation style were evaluated. The chosen approach prioritizes clarity and consistency.
How to test?
visit http://127.0.0.1:8000/v1/docs to view the API documentation
This PR resolve issue hotosm#219