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

Add README for API #51

Merged
merged 1 commit into from
Mar 11, 2023
Merged

Add README for API #51

merged 1 commit into from
Mar 11, 2023

Conversation

kthchew
Copy link
Contributor

@kthchew kthchew commented Feb 23, 2023

Issue

Create a README to document the API, #46.

Description

Contains a basic summary of the (two) current endpoints.

It's probably better to use a tool designed for API documentation in the long run (example) but this is a basic start.

Type Of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Test Steps

N/A

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Collaborator

@prayujt prayujt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@prayujt prayujt merged commit 25379ae into ufosc:main Mar 11, 2023
@kthchew kthchew deleted the api-docs branch March 13, 2023 20:02
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.

3 participants