Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
2 tasks done
grickard opened this issue Jul 22, 2023 · 1 comment · Fixed by #30
Closed
2 tasks done
Labels
good first issue Good for newcomers

Comments

@grickard
Copy link

grickard commented Jul 22, 2023

💭 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?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@grickard grickard changed the title 📚 Documentation: 📚 Documentation: Specify which filescan() return bool corresponds to infection Jul 22, 2023
@joeyouss joeyouss self-assigned this Jul 26, 2023
@joeyouss joeyouss added the good first issue Good for newcomers label Jul 26, 2023
@joeyouss
Copy link

Thank you for bringing this up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants