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 docstrings for intellisense for all non-generated public methods and classes #86

Open
razor-x opened this issue Jun 17, 2024 · 4 comments

Comments

@razor-x
Copy link
Contributor

razor-x commented Jun 17, 2024

@razor-x
Copy link
Contributor Author

razor-x commented Aug 5, 2024

#135

@razor-x
Copy link
Contributor Author

razor-x commented Aug 5, 2024

Current plan is to add some docstrings, see how they work with editor support, and then refine and copy edit them with @DebbieAtSeam's support.

@andrii-balitskyi
Copy link
Collaborator

All publicly exposed methods and classes are now documented with docstrings.

Here are a couple examples of how that looks like in the editor:
image
image

The only class without docstrings is SeamWebhookVerificationError. It's an alias of WebhookVerificationError imported from svix, which itself doesn't appear to have docstrings.

@razor-x
Copy link
Contributor Author

razor-x commented Aug 7, 2024

Nice. Next steps

If we go with Sphinx it might be make for better doc gen, but if we go with Google Style RST or markdown it may work "out of the box" in VSCode, yet we lose control over the output format if we put this on docs.seam.co.

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

No branches or pull requests

2 participants