tminka
commented
2 years ago To reply to Sid's comment, I think helper functions should go at the end, since they are less relevant when reading the code. See the stepdown rule.
Closed AlexRomeroPrieto closed 2 years ago
tminka
commented
2 years ago To reply to Sid's comment, I think helper functions should go at the end, since they are less relevant when reading the code. See the stepdown rule.
AlexRomeroPrieto
commented
2 years ago @microsoft-github-policy-service agree [company="Microsoft"]
The objective of this PR is to improve documentation of the project so it's easier for new folk to understand what's going on. I have added header comments to approximately half the code. I have also given it a more structured shape, dividing the script into different sections (top-level functions, transform functions and helper functions) which potentially could live in different files.
There's a few TODOs in some comments when I wasn't very sure if what I was understanding about the comment was correct or not. Please have a look and tell me if I got it right!
I have not changed anything about how the code works. Accuracy is still slightly over 70%.