search

chanzuckerberg / redis-memo

A Redis-based version addressable caching system. Memoize pure functions, aggregated database queries, and 3rd party API calls.
https://rubygems.org/gems/redis-memo
MIT License
33 stars 3 forks source link

[doc] Add rdocs for RedisMemo::MemoizeQuery #81

Closed katyho closed 3 years ago

katyho commented 3 years ago

Summary

Add rdocs for memoize_query

Testing

After making all other methods as private, specs still pass

codecov[bot] commented 3 years ago

Codecov Report

Merging #81 (6cb571b) into main (3dd9c57) will increase coverage by 0.11%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
+ Coverage   97.63%   97.75%   +0.11%     
==========================================
  Files          40       40              
  Lines        2328     2406      +78     
==========================================
+ Hits         2273     2352      +79     
+ Misses         55       54       -1
Impacted Files Coverage Δ
lib/redis_memo/memoize_query.rb 97.14% <100.00%> (+0.08%) :arrow_up:
lib/redis_memo/batch.rb 100.00% <0.00%> (ø)
lib/redis_memo/memoize_method.rb 99.37% <0.00%> (+1.33%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3dd9c57...6cb571b. Read the comment docs.

katyho commented 3 years ago

Need to fix build, also probably want to leave RedisMemo::MemoizeQuery.invalidate methods as public methods