Repository navigation
Fix broken storage examples and remaining Sphinx warnings - #1243
Draft
Omarinho12345 wants to merge 1 commit into
Draft
Omarinho12345 wants to merge 1 commit into
Omarinho12345 wants to merge 1 commit into
Conversation
The Redis setup examples still imported aioredis, which aiohttp-session stopped using in 2.12.0, and awaited redis.asyncio.from_url although it is a regular function. The Memcached setup example instantiated the client class instead of MemcachedStorage, and the class example awaited the synchronous aiomcache.Client constructor with Redis' default port. Also state that storages default to the AIOHTTP_SESSION cookie (the docs claimed AIOHTTP_COOKIE_SESSION, contradicting the example below it), replace the Travis CI reference with GitHub Actions, add the missing redis glossary term, drop a duplicate module directive and fix a few typos. The Sphinx build now completes without warnings (5 before).
Automation signalsActivity patterns show signs of automation. Evidence
Last 5 PRs:
This is an automated analysis by AgentScan |
This branch has not been deployed
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.
The storage examples in the docs no longer work:
aiorediswas replaced byredisin 2.12.0, andredis.asyncio.from_url()is a regular function, soawait aioredis.from_url(...)raisesModuleNotFoundError/TypeError.aiohttp_session.memcached_storage.Client(mc)does not exist (the module providesMemcachedStorage), so the snippet raisesAttributeError.await aiomcache.Client(...)awaits a synchronous constructor and uses port 6379, which is Redis' default.Also fixes documentation statements: storages use the
AIOHTTP_SESSIONcookie by default rather thanAIOHTTP_COOKIE_SESSION, GitHub Actions instead of Travis, the missingredisglossary term, a duplicate module directive, and a few typos.Verification:
sphinx-build -b html docs: 5 warnings onmaster, 0 after the change.redis.asyncio.from_url(...)+RedisStorageandaiomcache.Client("localhost", 11211)+MemcachedStorageconstruct withcookie_name == "AIOHTTP_SESSION"; the old calls fail as described.Docs only, no code changes.