Better documentation of the scripts

ualberta-smr / LibraryMetricScripts

Scripts to collect metrics from software libraries.

MIT License

4 stars 2 forks source link

Better documentation of the scripts #2

Closed snadi closed 6 years ago

snadi commented 6 years ago

Maybe have a ReadMe in each metric folder on what is the expected input and output of each script? The instructions at the top say the input but nothing about the output. We should also have a description of what the metric measures.

flopezde commented 6 years ago

Fixed. I added that information in each of the python files (Since we already mention to look for instructions there).