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

Write documentation #39

Open

2 tasks

meshy opened this issue May 13, 2024 · 1 comment

Labels

Docs

Contributor

meshy commented May 13, 2024

We should have (at least):

API docs.
Examples.

Blocked by #38

meshy added the Docs label

Contributor Author

meshy commented May 20, 2024

Some required examples:

Use as a context manager (as seen in the readme).
Use as a decorator (this approach surprised me, but I suppose it's valid).
Use with a through-table
Use of is_match without the refine ... manager.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment