SonarImporter docs examples are invalid

[moritz-suckow]

Bug

Expected Behavior

WHEN

I visit the SonarImporter documentation and look for examples on how to use the SonarImporter

THEN

I want the given examples to work.

Actual Behavior

The given examples must be modified in order to work.

Notes

If you use the commands, as described in the examples in the docs, the user will receive a strange error message:
Get values for metrics [erge-modules=false]

[moritz-suckow]

I looked at the documentation for the SonarImporter and I found the issue.

All parameters should be passed with -- infront of them, but in the documentation that is not the case, there we are using –instead.
After taking a look at the documentation in the code all commands are correctly specified in the documentation, but are somehow automatically converted from -- into – (which is not a singular - but rather some kind of bigger connected -).

[moritz-suckow]

Looking at the note my guess what happened:
Since copy pasting from the documentation right now results in every double dash being a single dash the command probably looked something like this:

ccsh sonarimport www.someprojecturl.de someprojectkey –user=someUserToken –output-file=someFileName –merge-modules=false

Now instead of --merge-modules we have -merge-modules which starts with -m which is the option specifiying the metrics.

The weird message normally outputs all metrics which will be imported. In this case the -merge-modules=false option was interpreted as -m erge-modules=false, so the "metrics" ccsh tried to import where erge-modules=false which is exactly the output.