Improve docs
Closed this issue · 0 comments
anitarua commented
- Add lint rule for missing docs ->
-W missing_docs
-> do this last to narrow down the warnings - Add
//!
docs to top-level modules (other modules too if needed?) - Some dictionary docs in cache_client are missing links to their *Request counterparts
- List length doc example:
cache_clientlist_length
->cache_client.list_length
(didn't see it) - Request docs examples should exercise optional arguments (list concat front/back, probably others)
-
send_request
should link to sorted set fetch by score example for optional fields instead because we changed fetch by rank to accept Optional args in thecache_client
function signature - Note that
tokio
works best with grpc in readme, our recommended async runtime, and should be installed when installing the Momento SDK - For return types that support Hit/Miss, we should include an example in the docstring showing
try_into
directly on the response object, without amatch
, to convert toHashMap
or whatever, in addition to showing thematch
approach.