measure.sh and measure-file.sh description inside metrics/README.md
#343
Conversation
…file.sh' files during make exectution inside 'metrics/README.md'
|
@yegor256 Please check if this fits necessary requirements |
metrics/README.md
Outdated
|
|
||
| ## Metrics in make | ||
|
|
||
| Metrics could be calculated in **measure** step presented in makefile. |
There was a problem hiding this comment.
@IlnurHA why it's "makefile" instead of Makefile?
metrics/README.md
Outdated
|
|
||
| ## Metrics in make | ||
|
|
||
| Metrics could be calculated in **measure** step presented in makefile. |
There was a problem hiding this comment.
@IlnurHA try to avoid bold and italic in tech documents, see: https://www.yegor256.com/2019/05/21/dont-improvise.html
metrics/README.md
Outdated
| * Creating necessary files and directories | ||
| * Collecting jobs to execute in parallel | ||
| (Currently, one for each java file to analyze metrics for) | ||
| * Executes jobs using `help/parallel.sh` |
There was a problem hiding this comment.
@IlnurHA why it's creating, collecting and then all of a sudden executes? Set the time of the verbs straight
|
@IlnurHA thanks! The text looks pretty dirty now, please, see the comments above. There are more problems, I hope you can find and fix them yourself. |
|
@yegor256 fixed what you asked. Please, check if it is suitable now |
metrics/README.md
Outdated
| @@ -25,3 +27,33 @@ the name of the metric. The second one contains the value (float or integer). | |||
| The third one contains the description of the metric (in general, NOT | |||
| for this particular file). A space is mandatory between the first and the | |||
| second column, and between the second and the third columns. | |||
|
|
|||
| ## Metrics in make | |||
There was a problem hiding this comment.
@IlnurHA the title doesn't sound right
metrics/README.md
Outdated
|
|
||
| ## Metrics in make | ||
|
|
||
| Metrics could be calculated in measure step presented in `Makefile`. |
|
@IlnurHA try to use ChatGPT to clean up the grammar, now it sounds pretty wrong |
|
@yegor256. Please check the description. Hopefully, it is in a better condition now |
|
@IlnurHA thanks! |
Readme file update as requested in this comment for the issue for better understanding of
steps/measure.shandsteps/measure-file.shinside make process and better contribution in the future