fix: Add async modules to the readthedocs API reference - #513
Merged
Merged
Conversation
Add automodule entries for ldclient.async_client (AsyncLDClient), ldclient.async_config (AsyncConfig), and ldclient.plugin (Plugin and AsyncPlugin, which had no entry at all). AsyncHook and AsyncMigrator are already covered by the existing hook/migrations :members: blocks. These modules import without aiohttp, so the docs build needs no async extra.
jsonbailey
marked this pull request as ready for review
September 3, 2026 13:28
joker23
approved these changes
Sep 3, 2026
jsonbailey
added a commit
that referenced
this pull request
Sep 25, 2026
🤖 I have created a release *beep* *boop* --- ## [9.18.0](9.17.0...9.18.0) (2026-09-25) ### Features * Add retry state for RETRY-spec backoff ([#522](#522)) ([e734558](e734558)) * Drive repeating tasks from a delay source ([9abe8cb](9abe8cb)) * Retry indefinitely after a data source failure instead of stopping permanently in FDv1 ([e17e173](e17e173)) * warn that payload filtering has no effect with FDv2 ([#518](#518)) ([296311f](296311f)) * Warn when the SDK is used in a forked process without postfork ([#512](#512)) ([75402e9](75402e9)) ### Bug Fixes * Add async modules to the readthedocs API reference ([#513](#513)) ([f40d3b2](f40d3b2)) * Log the cached-data evaluation warning only once per client ([#520](#520)) ([59ce998](59ce998)) * Read all items when a collection is empty ([#524](#524)) ([1087147](1087147)) * Repeating task wait duration is no longer reduced by a slow callback duration. ([9abe8cb](9abe8cb)) * Report a distinct User-Agent for the async client ([#516](#516)) ([514c467](514c467)) * Warn and use the documented default for an invalid poll interval or initial reconnect delay ([e17e173](e17e173)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > This PR **cuts release 9.18.0** by bumping the package version in `pyproject.toml`, `ldclient/version.py`, `.release-please-manifest.json`, and the provenance docs example, and by adding the **9.18.0** section to `CHANGELOG.md`. > > There is **no application code in the diff**—Release Please is packaging work that was already merged. The new changelog highlights **FDv1 data-source resilience** (indefinite retry after failures, RETRY-spec backoff state, repeating tasks driven by a delay source, and sane defaults/warnings for invalid poll/reconnect settings), **operational warnings** (forked process without `postfork`, FDv2 payload filtering), and **fixes** (empty-collection reads, repeating-task timing, one-time cached-data warnings, distinct async `User-Agent`, ReadTheDocs async API docs). > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit eef08a1. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Jason Bailey <jbailey@launchdarkly.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
The readthedocs API reference (
docs/api-main.rst) documented no async modules. This addsautomoduleentries so the experimental async surface shows up in the generated docs.New entries:
ldclient.async_client—AsyncLDClientldclient.async_config—AsyncConfigldclient.plugin—PluginandAsyncPlugin(this module had no entry at all; a pre-existing gap for the syncPlugintoo)AsyncHook(ldclient.hook) andAsyncMigrator(ldclient.migrations) were already swept in by the existing:members:blocks, so they need no new entry.These modules import without
aiohttp, so the docs build needs no[async]extra.make docsbuilds cleanly and all three modules render.Part of the async SDK documentation follow-up (SDK-2879). The async surface shipped experimentally in 9.17.0.
Note
Overview
Extends
docs/api-main.rstso the generated API reference includes the experimental async surface and a previously missing plugin section.Adds Sphinx
automoduleblocks forldclient.async_client(AsyncLDClient),ldclient.async_config, andldclient.plugin(sync and async plugin types). No runtime or SDK behavior changes—docs build only, aligned with SDK-2879.Reviewed by Cursor Bugbot for commit 1c478e4. Bugbot is set up for automated code reviews on this repo. Configure here.