Commit 2ceb431cb44ca07952de9d4fdae80cc8c2c620ad
Committed by
Diego Camarinha
Diego Camarinha
1 parent
840c905c
Exists in
colab
and in
4 other branches
[WIP] Working on tooltips and keywords
Signed off by: Heitor Reis <marcheing@gmail.com>
Showing
4 changed files
with
30 additions
and
24 deletions
Show diff stats
app/assets/stylesheets/form_with_tooltip.css
app/views/metric_configurations/_form.html.erb
| ... | ... | @@ -10,7 +10,7 @@ |
| 10 | 10 | </div> |
| 11 | 11 | <div class="help-container"> |
| 12 | 12 | <p> |
| 13 | - The Weight of a metric is used to calculate the weighted average of a <%= link_to 'module', tutorials_path("keywords", anchor: "module")%>. | |
| 13 | + It is used to calculate the weighted average of a <%= link_to 'module', tutorials_path("keywords", anchor: "module")%>. | |
| 14 | 14 | </p> |
| 15 | 15 | </div> |
| 16 | 16 | </div> |
| ... | ... | @@ -22,7 +22,7 @@ |
| 22 | 22 | </div> |
| 23 | 23 | <div class="help-container"> |
| 24 | 24 | <p> |
| 25 | - It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of classes inside a package). | |
| 25 | + It is the calculation of statistical results for higher <%= link_to 'granularity', tutorials_path('keywords', anchor: 'granularity') %> modules (e.g., average lines of code of the classes inside a package). | |
| 26 | 26 | </p> |
| 27 | 27 | </div> |
| 28 | 28 | </div> | ... | ... |
app/views/mezuro_configurations/_form.html.erb
| ... | ... | @@ -9,11 +9,6 @@ |
| 9 | 9 | <%= f.label :name, class: 'control-label' %><br> |
| 10 | 10 | <%= f.text_field :name, class: 'text-field' %> |
| 11 | 11 | </div> |
| 12 | - <div class="help-container"> | |
| 13 | - <p> | |
| 14 | - The name of your Configuration. | |
| 15 | - </p> | |
| 16 | - </div> | |
| 17 | 12 | </div> |
| 18 | 13 | |
| 19 | 14 | <div class="form-row"> |
| ... | ... | @@ -21,11 +16,6 @@ |
| 21 | 16 | <%= f.label :description, class: 'control-label' %><br> |
| 22 | 17 | <%= f.text_area :description, class: 'text-area' %> |
| 23 | 18 | </div> |
| 24 | - <div class="help-container"> | |
| 25 | - <p> | |
| 26 | - A short description of your Configuration. | |
| 27 | - </p> | |
| 28 | - </div> | |
| 29 | 19 | </div> |
| 30 | 20 | |
| 31 | 21 | </div> | ... | ... |
app/views/tutorials/keywords.html.erb
| ... | ... | @@ -7,36 +7,52 @@ |
| 7 | 7 | <div> |
| 8 | 8 | <h3 id="granularity">Granularity</h3> |
| 9 | 9 | |
| 10 | - <p>Mezuro uses four levels of granularity:</p> | |
| 11 | - <ul> | |
| 12 | - <li>Method</li> | |
| 13 | - <li>Class</li> | |
| 14 | - <li>Package</li> | |
| 15 | - <li>Software</li> | |
| 16 | - </ul> | |
| 10 | + <p>Represents the granularity level of the code fragment being measured. Mezuro uses four levels of granularity:</p> | |
| 11 | + <ul> | |
| 12 | + <li>Method</li> | |
| 13 | + <li>Class</li> | |
| 14 | + <li>Package</li> | |
| 15 | + <li>Software</li> | |
| 16 | + </ul> | |
| 17 | 17 | </div> |
| 18 | 18 | |
| 19 | 19 | <div> |
| 20 | 20 | <h3 id="module">Module</h3> |
| 21 | 21 | |
| 22 | - <p>Represents a fragment of the software. Every node in the processing tree generated by the Kalibro processor is a module. It can be a software package, file or the whole software.</p> | |
| 22 | + <p>Represents a fragment of the software. Every node in the processing tree generated by the Kalibro processor is a module and each module has a <i>granularity</i>.</p> | |
| 23 | 23 | </div> |
| 24 | 24 | |
| 25 | 25 | <div> |
| 26 | 26 | <h3 id="range">Range</h3> |
| 27 | 27 | |
| 28 | - <p>Represents numerical intervals that may contain the value calculated for a given metric. Ranges combined with readings provide interpretations for metric results.</p> | |
| 28 | + <p>Represents numerical intervals that may contain the value calculated for a given <i>metric</i>. Ranges combined with readings provide interpretations for <i>metric results</i>.</p> | |
| 29 | 29 | </div> |
| 30 | 30 | |
| 31 | 31 | <div> |
| 32 | 32 | <h3 id="reading">Reading</h3> |
| 33 | 33 | |
| 34 | - <p>The interpretation given to a metric result (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for metric results.</p> | |
| 34 | + <p>The interpretation given to a <i>metric result</i> (e.g., "Good", "Complex", "A"). Readings combined with ranges provide interpretations for <i>metric results</i>.</p> | |
| 35 | 35 | </div> |
| 36 | 36 | |
| 37 | 37 | <div> |
| 38 | 38 | <h3 id="reading-group">Reading Group</h3> |
| 39 | 39 | |
| 40 | - <p>A set of readings that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p> | |
| 40 | + <p>A set of <i>readings</i> that make sense when grouped together (e.g., "Good" and "Bad", "Simple" and "Complex").</p> | |
| 41 | + </div> | |
| 42 | + <div> | |
| 43 | + <h3 id="configuration">Configuration</h3> | |
| 44 | + | |
| 45 | + <p></p> | |
| 46 | + </div> | |
| 47 | + <div> | |
| 48 | + <h3 id="metric_result">Metric Result</h3> | |
| 49 | + | |
| 50 | + <p>It is a numerical result associated to a metric by the Collector or aggregating in the case of a Compound Metric</p> | |
| 51 | + </div> | |
| 52 | + | |
| 53 | + <div> | |
| 54 | + <h3 id="metric">Metric</h3> | |
| 55 | + <p>A software metric is a quantitative measure of some property of a module. For more details see | |
| 56 | + <%= link_to 'Carlos Morais dissertation', 'http://www.teses.usp.br/teses/disponiveis/45/45134/tde-25092013-142158/publico/dissertacao.pdf' %>.</p> | |
| 41 | 57 | </div> |
| 42 | 58 | </div> | ... | ... |