Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complex SI quantities are missing documentation strings of real and imaginary part #2443

Closed
christiankral opened this issue Jan 24, 2018 · 0 comments
Assignees
Labels
enhancement New feature or enhancement L: SIunits Issue addresses Modelica.SIunits
Milestone

Comments

@christiankral
Copy link
Contributor

This issue applies to all complex SI units of Modelica.SIunits.Complex.... For example, the definition of the complex current in Modelica.SIunits.ComplexCurrent

operator record ComplexCurrent =
  Complex(redeclare Modelica.SIunits.Current re,
          redeclare Modelica.SIunits.Current im)
  "Complex electrical current";

but shall contain documentation strings

operator record ComplexCurrent =
  Complex(redeclare Modelica.SIunits.Current re "Real part of complex current",
          redeclare Modelica.SIunits.Current im "Imaginary part of complex current")
  "Complex electrical current";

The documentation strings shall be added for all complex SI units in Modelica.SIunits.

@christiankral christiankral added enhancement New feature or enhancement L: SIunits Issue addresses Modelica.SIunits labels Jan 24, 2018
@christiankral christiankral added this to the maintenance milestone Jan 24, 2018
@christiankral christiankral self-assigned this Jan 24, 2018
christiankral added a commit that referenced this issue Jan 28, 2018
Missing documentation strings of real and imaginary parts of complex SI units
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or enhancement L: SIunits Issue addresses Modelica.SIunits
Projects
None yet
Development

No branches or pull requests

1 participant