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

[Feature]: Proper documentation #10427

Open
4 tasks done
based64-eth opened this issue Feb 1, 2025 · 0 comments
Open
4 tasks done

[Feature]: Proper documentation #10427

based64-eth opened this issue Feb 1, 2025 · 0 comments

Comments

@based64-eth
Copy link

CheckList

  • I agree to follow this project's Code of Conduct
  • I have read and followed the Contributing Guide
  • I have searched and referenced existing issues, feature requests and discussions
  • I am filing a FEATURE request.

Description

Please write proper documentation for this library, especially for v6.

I could find almost nothing in the docs and had to resort to much googling and relying on comments from 2-4 years ago.

Current State

The current state of the documentation is extremely poor.

A glossary of classes, properties and methods is not documentation, especially if its missing a lot of information.

Additional Context

No response

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

1 participant