jazzband/django-redis

Lock documentation missing any information on what it is not suitable for

Open

#398 opened on Nov 16, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (452 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (3,075 stars)
PR merge metrics
 (PR metrics pending)

Description

The lock documentation suggests that this can be used to create redis distributed named locks, possibly redlocks.

The implementation of lock django-redis puts this on the underlying redis connection library, as far as I can tell this is redis-py, which says the following about its lock implementation

It's left to the user to resolve deadlock issues and make sure multiple clients play nicely together.

The documentation for lock should include this caveat.

Contributor guide

Research direction
Add the redis py lock caveat about deadlock resolution and mutual cooperation to the django redis lock documentation.
Tech stack
pythondjangoredis
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonDjangoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85