VirusTotal / yara-python

The Python interface for YARA
http://virustotal.github.io/yara/
Apache License 2.0
650 stars 179 forks source link

Documentation is not updated to reflect changes in 4.3.0 #231

Closed seanthegeek closed 10 months ago

seanthegeek commented 1 year ago

The documentation at https://yara.readthedocs.io/en/stable/yarapython.html is outdated, and does not mention the changes made in 4.3.0. For example, the documentation still states:

The strings fields is a list of matching strings, with vectors of the form:
(<offset>, <string identifier>, <string data>)

But in 4.3.0, this was changed from a tuple to a StringMatch object.

There might be other outdated parts of the documentation.

See also: https://github.com/VirusTotal/yara-python/issues/226

wxsBSD commented 1 year ago

Thanks for the catch. Fixed the docs with https://github.com/VirusTotal/yara/pull/1909.

seanthegeek commented 1 year ago

Looks like the change hasn't been pushed to readthedocs yet.

plusvic commented 10 months ago

Changes already visible in https://yara.readthedocs.io/en/stable/yarapython.html