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

Update/review v3 docs #120

Open
8 tasks
JWCook opened this issue Aug 27, 2023 · 2 comments
Open
8 tasks

Update/review v3 docs #120

JWCook opened this issue Aug 27, 2023 · 2 comments

Comments

@JWCook
Copy link
Contributor

JWCook commented Aug 27, 2023

Follow-up from #111 (review)

Tasks:

  • Add parameter documentation for all public classes and functions
  • Update to Sphinx v7 if possible, and verify other doc dependencies/extensions are still working
  • Verify structure and content in HTML docs:
    • Table of contents and sidebar page outlines
    • Auto-generated module docs (via sphinx-apidoc)
  • Verify formatting in HTML docs:
    • Docs generated from docstrings
    • Docs generated from markdown
@JWCook JWCook mentioned this issue Aug 27, 2023
4 tasks
@JWCook
Copy link
Contributor Author

JWCook commented Sep 19, 2023

I haven't been able to get to this yet, but I still plan to as soon as I have the time.

@andrew-cybsafe
Copy link

Given the substantial changes from 2.x to 3.x, I'd suggest that a migration guide would be very helpful. e.g.

  • how do I implement @limiter.ratelimit("...", delay=True) in v3.
  • RequestRate class has renamed to Rate

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