mirror of https://github.com/kivy/kivy.git
doc: changed key/value (either/or) to key-value syntax in storage/__init__.py
This commit is contained in:
parent
c203cda05c
commit
8c8453bf7a
|
@ -13,7 +13,7 @@ Usage
|
|||
-----
|
||||
|
||||
The idea behind the Storage module is to be able to load/store any number of
|
||||
key/value pairs via an indexed key. The default model is abstract so you
|
||||
key-value pairs via an indexed key. The default model is abstract so you
|
||||
cannot use it directly. We provide some implementations such as:
|
||||
|
||||
- :class:`kivy.storage.dictstore.DictStore`: use a python dict as a store
|
||||
|
@ -36,7 +36,7 @@ For example, let's use a JsonStore::
|
|||
store.put('tito', name='Mathieu', org='kivy')
|
||||
store.put('tshirtman', name='Gabriel', age=27)
|
||||
|
||||
# using the same index key erases all previously added key/value pairs
|
||||
# using the same index key erases all previously added key-value pairs
|
||||
store.put('tito', name='Mathieu', age=30)
|
||||
|
||||
# get a value using a index key and key
|
||||
|
@ -154,7 +154,7 @@ class AbstractStore(EventDispatcher):
|
|||
key=key, callback=callback)
|
||||
|
||||
def get(self, key):
|
||||
'''Get the key/value pairs stored at `key`. If the key is not found, a
|
||||
'''Get the key-value pairs stored at `key`. If the key is not found, a
|
||||
`KeyError` exception will be thrown.
|
||||
'''
|
||||
return self.store_get(key)
|
||||
|
@ -173,8 +173,8 @@ class AbstractStore(EventDispatcher):
|
|||
self._schedule(self.store_get_async, key=key, callback=callback)
|
||||
|
||||
def put(self, key, **values):
|
||||
'''Put new key/value pairs (given in *values*) into the storage. Any
|
||||
existing key/value pairs will be removed.
|
||||
'''Put new key-value pairs (given in *values*) into the storage. Any
|
||||
existing key-value pairs will be removed.
|
||||
'''
|
||||
need_sync = self.store_put(key, values)
|
||||
if need_sync:
|
||||
|
@ -222,7 +222,7 @@ class AbstractStore(EventDispatcher):
|
|||
def find(self, **filters):
|
||||
'''Return all the entries matching the filters. The entries are
|
||||
returned through a generator as a list of (key, entry) pairs
|
||||
where *entry* is a dict of key/value pairs ::
|
||||
where *entry* is a dict of key-value pairs ::
|
||||
|
||||
for key, entry in store.find(name='Mathieu'):
|
||||
print('key:', key, ', entry:', entry)
|
||||
|
|
Loading…
Reference in New Issue