Use ellipses in documentation

modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.

https://doc.modelica.org

BSD 3-Clause "New" or "Revised" License

476 stars 169 forks source link

Use ellipses in documentation #2749

Open tobolar opened 6 years ago

tobolar commented 6 years ago

Relying on @kristinmajetta's comment https://github.com/modelica/ModelicaStandardLibrary/pull/2748#issuecomment-431257338 and on https://en.wikipedia.org/wiki/Ellipsis#In_mathematical_notation, a row of three points (ellipsis) should be used for lists (or ranges) of numbers within the MSL's documentation. At the moment, mostly just two points are used.

To perform this properly, a HTML entity shall be used:

&#8230;  or  &#x2026;  or  &hellip;

If agreed, we can also add some recommendation in Modelica.UsersGuide.Conventions.Documentation.

HansOlsson commented 6 years ago

The decimal variant … is confusing for me, and … seems easiest to understand.

tobolar commented 6 years ago

@HansOlsson You are absolutely right. This is just for completeness.

beutlich commented 6 years ago

I do not mind which HTML entity to use. Just go ahead with it. Thanks.

dietmarw commented 6 years ago

&hellip would be my preference since actually recognisable without having to search for the meaning.