1. Matthew Frazier
  2. redismap

Commits

Matthew Frazier  committed 4aaafc7

fixed the WhateverView docs in collections.rst

  • Participants
  • Parent commits fa4356a
  • Branches default

Comments (0)

Files changed (2)

File docs/collections/native.rst

View file
 sets, lists, sorted sets, and hashes. Sets, lists, and hashes mimic the
 interfaces of their Python equivalents - `set`, `list`, and `dict` - as much
 as possible. (Sorted sets have no real Python equivalent, but their interface
-is a hybrid of the `set` and `dict` interface.)
+is a hybrid of the `set` and `dict` interface.) Each has a read-write version,
+and a read-only version suffixed with `View`.
 
 All of them support using non-string types as values (and keys and scores,
 as appropriate) by passing :ref:`converters` to the constructor.
 
 Sets
 ====
+.. autoclass:: SetView
+   :members:
+
 .. autoclass:: Set
    :members:
 
 
 Lists
 =====
+.. autoclass:: ListView
+   :members:
+
 .. autoclass:: List
    :members:
 
 
 Sorted Sets
 ===========
+.. autoclass:: SortedSetView
+   :members:
+
 .. autoclass:: SortedSet
    :members:
 
 
 Hashes
 ======
+.. autoclass:: HashView
+   :members:
+
 .. autoclass:: Hash
    :members:

File docs/converters.rst

View file
 .. currentmodule:: redismap
 
+.. _converters:
+
 ==========
 Converters
 ==========