search

Sasafrass / straattaal

Use an RNN to generate Dutch slang and interpret your newly created words!
GNU General Public License v2.0
8 stars 0 forks source link

Initial docstring updates. #48

Closed Sasafrass closed 3 years ago

Sasafrass commented 3 years ago

This is a Work In Progress PR in which we should attempt to update all missing docstrings. To see which docstrings still have to be written, cmd into the "app" folder and do pydocstyle (if pydocstyle is installed). Please feel free to add and commit as many docstrings to functions to this PR as you like. Re-running pydocstyle will tell you whether the written docstring fulfills the criteria.

I have made a quick start with implementing a number of docstrings that were missing in the models module.

annaproxy commented 3 years ago

I did the ml_models directory.

I removed the old helpers.py and slangreader.py. This is done in different files now - there were no further references to it (and we can dig them up from git history if necessary)

Sasafrass commented 3 years ago

Cool. Indeed, they had redundant functionality so it is fine to remove them.

Sasafrass commented 3 years ago

Removed Work In Progress label. Should now pass Pydocstyle for the entire project, including the /app folder and the parent folder files (config.py and straattaal.py) - please double check.