Which notation should be use in docs when parameters are explained?

[JorTurFer]

We don't have defined the notation that should be use when you are explaining things like parameters in docs. That's why you can find notations like these:

• Parameter - Description
• Parameter: Description
• Parameter: Description

In the same way, in some cases the sentences finish with a dot and in other cases don't.

I'd like to review all the docs and unify the styles, but maybe the styles should be decided before it.

WDTY?

[tomkerkhove]

• Parameter - Description

This is what is used for the majority and would love to use that.

[JorTurFer]

Nice, without final dot, right?

[tomkerkhove]

I have missed that part, it should have a . at the end since it's a sentence

[tomkerkhove]

Created #540

[JorTurFer]

Okey,
I think the same, but we have to consolidate this part also in all scalers xD
I will start working on this during the weekend
Thanks!