Improve documentation for Memory store #196

msssk · 2016-08-31T00:27:25Z

document sync methods in a table
explain when to use sync methods
document setData method

Stores.md: Memory store: * add documentation of 'setData' * improve organization of sync method docs

dylans · 2016-08-31T00:37:20Z

docs/Store.md

+Stores that can perform synchronous operations may provide analogous methods for `get`, `put`, `add`, and `remove` that end with `Sync` to provide synchronous support. For example `getSync(id)` will directly return an object instead of a promise. The `dstore/Memory` store provides `Sync` methods in addition to the promise-based methods. This behavior has been separated into distinct methods to provide consistent return types.
+
+It is generally advisable to always use the synchronous methods so that client code does not have to be updated in case the store is changed. However, if you have very performance intensive store accesses, the synchronous methods can be used to avoid the minor overhead imposed by promises.


I think you meant asynchronous on the first part of line 35, "It is generally advisable to always use the synchronous methods so that"

Thank you! A very important distinction, fixed it!

edhager · 2016-09-28T15:54:06Z

Thanks @msssk!

msssk added 2 commits August 30, 2016 16:20

Store: improve documentation about sync methods

2ac07a8

Store.md: fix typos

da21c79

Stores.md: Memory store: * add documentation of 'setData' * improve organization of sync method docs

msssk assigned edhager Aug 31, 2016

dylans reviewed Aug 31, 2016
View reviewed changes

Store.md: fix typo

7b70282

edhager closed this in ffb8550 Sep 28, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation for Memory store #196

Improve documentation for Memory store #196

msssk commented Aug 31, 2016

dylans Aug 31, 2016 •

edited

Loading

msssk Sep 6, 2016

edhager commented Sep 28, 2016

		Stores that can perform synchronous operations may provide analogous methods for `get`, `put`, `add`, and `remove` that end with `Sync` to provide synchronous support. For example `getSync(id)` will directly return an object instead of a promise. The `dstore/Memory` store provides `Sync` methods in addition to the promise-based methods. This behavior has been separated into distinct methods to provide consistent return types.

		It is generally advisable to always use the synchronous methods so that client code does not have to be updated in case the store is changed. However, if you have very performance intensive store accesses, the synchronous methods can be used to avoid the minor overhead imposed by promises.

Improve documentation for Memory store #196

Improve documentation for Memory store #196

Conversation

msssk commented Aug 31, 2016

dylans Aug 31, 2016 • edited Loading

Choose a reason for hiding this comment

msssk Sep 6, 2016

Choose a reason for hiding this comment

edhager commented Sep 28, 2016

dylans Aug 31, 2016 •

edited

Loading