Modernize some of the djblets.cache documentation.
Review Request #7371 — Created June 2, 2015 and submitted
The djblets.cache documentation was amongst the oldest sets of docs in
the codebase, and weren't anywhere close to PEP-257-compliant, nor did they
render well in our new doc builds.I've gone through and updated the public-facing documentation, making it
compliant with PEP 257 and helping it render links and text properly.
I've also fleshed out some of the documentation to clear up some points.In order to link to Django docs for some of the settings, I needed to
add a new extension, djangorefs, which sets up the cross reference types
needed.
Built the docs and read through them.
Change Summary:
Added module-level docstrings.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+154 -58) |
-
Tool: PEP8 Style Checker Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst Tool: Pyflakes Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst
-
-
djblets/cache/backend_compat.py (Diff revision 2) This is confusing to me. You say it will return a CACHES dictionary, and then tell me it won't be CACHES, but something else that hasn't been defined yet.
-
Change Summary:
- Reworded a confusing section.
- Changed a type from
strtounicode.
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 3 (+153 -58) |
-
Tool: Pyflakes Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst Tool: PEP8 Style Checker Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst
Tool: Pyflakes Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst Tool: PEP8 Style Checker Processed Files: djblets/cache/context_processors.py docs/djblets/_ext/djangorefs.py docs/djblets/conf.py djblets/cache/forwarding_backend.py djblets/cache/serials.py djblets/cache/backend_compat.py djblets/cache/backend.py Ignored Files: docs/djblets/coderef/index.rst