Merge: doc: fixed some typos and other misc. corrections

[nit.git] / share / man / nitmetrics.md

diff --git a/share/man/nitmetrics.md b/share/man/nitmetrics.md
index 9b01489..9d7dfc6 100644 (file)
--- a/share/man/nitmetrics.md
+++ b/share/man/nitmetrics.md
@@ -1,5 +1,3 @@
-% NITMETRICS(1)
-
 # NAME
 
 nitmetrics -- computes various metrics on Nit programs.
@@ -12,58 +10,66 @@ nitmetrics [*options*]... FILE...
 
 ## METRICS
 
-`--all`
-:   Compute all metrics
+### `--all`
+Compute all metrics.
+
+### `--mmodules`
+Compute metrics about mmodules.
+
+### `--mclasses`
+Compute metrics about mclasses.
+
+### `--mendel`
+Compute mendel metrics.
 
-`--mmodules`
-:   Compute metrics about mmodules
+### `--inheritance`
+Compute metrics about inheritance usage.
 
-`--mclasses`
-:   Compute metrics about mclasses
+### `--refinement`
+Compute metrics about refinement usage.
 
-`--mendel`
-:   Compute mendel metrics
+### `--self`
+Compute metrics about the usage of explicit and implicit self.
 
-`--inheritance`
-:   Compute metrics about inheritance usage
+### `--ast`
+Compute metrics about the usage of nodes and identifiers in the AST.
 
-`--refinement`
-:   Compute metrics about refinement usage
+### `--nullables`
+Compute metrics on nullables send.
 
-`--self`
-:   Compute metrics about the usage of explicit and implicit self
+### `--static-types`
+Compute explicit static types metrics.
 
-`--ast`
-:   Compute metrics about the usage of nodes and identifiers in the AST
+### `--tables`
+Compute tables metrics.
 
-`--nullables`
-:   Compute metrics on nullables send
+### `--rta`
+Compute RTA metrics.
 
-`--static-types`
-:   Compute explicit static types metrics
+### `--generate_hyperdoc`
+Generate Hyperdoc.
 
-`--tables`
-:   Compute tables metrics
+### `--poset`
+Complete metrics on posets.
 
-`--rta`
-:   Compute RTA metrics
+### `--detect-variance-constraints`
+Detect the definition-site variance constraints on formal parameters.
 
-`--generate_hyperdoc`
-:   Generate Hyperdoc
+Infers the possible variance annotations of formal types in Nit programs by identifying the existing constraints on the usage of those formal type.
 
-`--poset`
-:   Complete metrics on posets
+### `--detect-covariance`
+Detect the static covariance usages.
 
 ## OUTPUT
 
-`--csv`
-:   Also export metrics in CSV format.
+### `--csv`
+Also export metrics in CSV format.
 
-`-d`, `--dir`
-:   Directory where some statistics files are generated.
+### `-d`, `--dir`
+Directory where some statistics files are generated.
 
-`--no-colors`
-:   Disable colors in console outputs.
+### `--no-colors`
+Disable colors in console outputs.
 
 # SEE ALSO