Repository navigation
Update README to match the code - #60
Merged
Merged
Conversation
- Fix fixture descriptions that disagreed with the code (memory_root_dir, memory_temp_dir, run_dir, lock_resource_timeout, memcached extra name). - Document missing fixtures (memcached_clean, mysql_* helpers) and clean_django_settings. - Add a Requirements section listing the needed system programs. - Fix the MySQL example to connect through the unix socket. - Warn that django_settings is incompatible with current Python/Django. - Replace the dead Travis/Coveralls badges with the GitHub Actions badge, update PyPI/http links and master -> main. - Use double backticks for inline literals and fix typos. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
nicoddemus
force-pushed
the
readme-fixes
branch
from
November 18, 2026 20:32
c0d3444 to
a2f051e
Compare
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.
Reviewed the README against the code and fixed what had drifted:
Incorrect descriptions
memory_root_dir: defaults to/dev/shm(not/var/shm), only when it has enough free space, falling back toroot_dir.memory_temp_diris a subfolder ofmemory_base_dir, notbase_dir;run_diris a subfolder ofmemory_temp_dir, notmemory_root_dir.lock_resource_timeout: clarify it is the max seconds to wait for a resource lock (default 20).memcached(notmemcache), and onlymemcached_client/memcached_cleanneedpylibmc.unix_socket=mysql_socket(the server runs with--skip-networking) and note it needsmysqlclient.Missing documentation
memcached_clean, themysql_*helper fixtures andclean_django_settings.django_settingswarningpytest_services.django_settingsis incompatible with current Python/Django (impwas removed in Python 3.12,django.core.urlresolversin Django 2.0). The code itself still needs fixing or removing; that's left for a follow-up.Housekeeping
pypi.python.org→pypi.org,http→https,master→main.Validated with docutils (no warnings) and
readme_renderer(PyPI rendering).🤖 Generated with Claude Code
This change is