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

Enhance/user-extract-api #3

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

KafayatYusuf
Copy link
Owner

@KafayatYusuf KafayatYusuf commented Apr 6, 2024

What type of PR is this?

Check all applicable

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (please specify)

What does this PR do?

Improves documentation quality of the extract endpoint by introducing the followings:

  • Removes trailing slashes
  • Added google docstrings to functions for proper documentation of codes

Consideration:

  • Removing trailing slashes improves the aesthetics of the URLs, making them cleaner and more consistent
  • Introducing a google docstring provides a convenient way of associating documentation with Python functions, classes and modules etc.

How to test?

Visit the link below to access the API documentation
Raw API Documentation

Screenshots :

image

Checklists:

Checklist before requesting review :

  • πŸ“– Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
  • πŸ‘·β€β™€οΈ Create small PRs. In most cases, this will be possible.
  • βœ… Provide tests for your changes.
  • πŸ“ Use descriptive commit messages.
  • πŸ“— Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?

organizing

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