added yara_binary_search docs

[jstucke]

No description provided.

[codecov-io]

Codecov Report

Merging #520 (10a6286) into master (479906e) will increase coverage by 0.10%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #520      +/-   ##
==========================================
+ Coverage   95.47%   95.57%   +0.10%     
==========================================
  Files         302      302              
  Lines       17684    18089     +405     
==========================================
+ Hits        16883    17288     +405     
  Misses        801      801              

Impacted Files	Coverage Δ
src/helperFunctions/yara_binary_search.py	100.00% <100.00%> (ø)
src/compare/PluginBase.py	100.00% <0.00%> (ø)
src/helperFunctions/hash.py	100.00% <0.00%> (ø)
src/test/acceptance/auth_base.py	100.00% <0.00%> (ø)
src/test/acceptance/test_misc.py	100.00% <0.00%> (ø)
src/test/unit/test_manage_users.py	100.00% <0.00%> (ø)
src/web_interface/rest/rest_base.py	100.00% <0.00%> (ø)
src/web_interface/rest/rest_binary.py	100.00% <0.00%> (ø)
src/test/unit/objects/test_firmware.py	100.00% <0.00%> (ø)
src/test/unit/scheduler/test_unpack.py	100.00% <0.00%> (ø)
... and 125 more

---

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 479906e...86b095b. Read the comment docs.

[dorpvom]

It think we can improve the wording here. How 'bout:

This class provides functionality to scan files in the database for yara patterns. The public method allows to either match a given set of patterns on all files in the database or focus only on files included in a single firmware.

[jstucke]

I agree → changed