Skip to content

docs: improve editor documentation and usage examples - #15

Merged
dariyaanis merged 1 commit into
mainfrom
docs/improve-editor-documentation
Oct 9, 2026
Merged

dariyaanis merged 1 commit into
mainfrom
docs/improve-editor-documentation

Conversation

@dariyaanis

Copy link
Copy Markdown
Collaborator

Developers can now read runnable usage snippets and fuller configuration and error documentation directly in editor hover and signature help.

  • Add examples to all 15 CAPTCHA task classes and the public API methods of both sync and async clients.
  • Document client settings on the class, clarify polling versus HTTP request timeouts, and describe exception attributes.
  • Explain editor setup in README and docstring maintenance in DEVELOPMENT.md.

This change only updates documentation; runtime behavior and public signatures are unchanged. Based on current main. The reCAPTCHA v2 example is unchanged and is not part of this PR.

Validation:

  • 82 tests passed after applying the changes to current main.
  • Ruff lint and formatting checks passed.
  • mypy, wheel/sdist build, and strict twine checks passed during local validation.
  • Jedi resolved documentation and constructor signatures for all 17 client/task classes from an installed wheel; py.typed was present in both distributions.

@dariyaanis
dariyaanis merged commit 116fa7d into main Oct 9, 2026
6 checks passed
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

Successfully merging this pull request may close these issues.

1 participant