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

Add Documentation to Vulgar Detector #52

Open
3 tasks
William-McGonagle opened this issue Dec 28, 2021 · 0 comments
Open
3 tasks

Add Documentation to Vulgar Detector #52

William-McGonagle opened this issue Dec 28, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@William-McGonagle
Copy link
Member

Idea

The backend server is getting huge, but we do not have a ton of documentation. This is a huge problem because there are people that would like to work on the project but are not sure where to start or what our code does.

One of the parts of our system that is relatively unknown is the vulgar detector. I had to build this system to check all of the biographies and posts, and it works quite well at the moment (that's beside the point). We need to add some basic documentation that describes how the vulgar detector works and how to use it.

You can find the code for the vulgar detector here, and it should be readable. If you would like to do this, comment below, and I'll assign you to the issue.

Todo

  • Document the GetVulgarWords() method
  • Document the TokenizeString() method
  • Document the DetectVulgarWords() method
@William-McGonagle William-McGonagle added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
No open projects
Status: Todo
Development

No branches or pull requests

1 participant