openzim / python-libzim

Libzim binding for Python: read/write ZIM files in Python
https://pypi.org/project/libzim/
GNU General Public License v3.0
62 stars 20 forks source link

Renamed search/suggestions count methods to imply estimation #79

Closed rgaudin closed 4 years ago

rgaudin commented 4 years ago

Methods get_*_results_count returns an estimated number of results (from the libzim). It is important that the method names doesn't mislead users into thinking it's a definitive count.

This thus renames both methods and updates docstrings

codecov[bot] commented 4 years ago

Codecov Report

Merging #79 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #79   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           99        99           
=========================================
  Hits            99        99           

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 48fafbe...f413182. Read the comment docs.