appwrite / php-clamav

ClamAV network and pipe client for PHP
https://github.com/appwrite
MIT License
65 stars 30 forks source link

📚 Documentation: Specify which filescan() return bool corresponds to infection #29

Closed grickard closed 1 year ago

grickard commented 1 year ago

💭 Description

Thank you for this integration!

Presently the documentation simply states:

// Return true of false for file scan

In my opinion, it would be more intuitive to specify which bool return value indicates infected vs not. So maybe revise this line to say:

// Returns true if a file is clean or false if a file is infected

👀 Have you spent some time to check if this issue has been raised before?

🏢 Have you read the Code of Conduct?

joeyouss commented 1 year ago

Thank you for bringing this up.