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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #13

Closed
s-heppner opened this issue Mar 7, 2025 · 0 comments · Fixed by #14
Closed

Improve documentation #13

s-heppner opened this issue Mar 7, 2025 · 0 comments · Fixed by #14
Labels
documentation Improvements or additions to documentation

Comments

@s-heppner
Copy link
Owner

Currently, the documentation is pretty bad.
We should update at least the README.md.
@s-heppner s-heppner added the documentation Improvements or additions to documentation label Mar 7, 2025
s-heppner added a commit that referenced this issue Mar 10, 2025
@s-heppner
Improve documentation
6d8822f 
This adds significantly to the `README.md`.
Furthermore, we adapt the `fastapi.API()` class
to include more documentation which gets displayed
in the automatically generated OpenAPI
specification of the interface.

Fixes #13
@s-heppner s-heppner mentioned this issue Mar 10, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation s-heppner/python-semantic-matcher
1 participant
@s-heppner