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

Annotations 'tab' and 'group' in Camel Case #3103

Closed
tobolar opened this issue Sep 2, 2019 · 5 comments · Fixed by #3110
Closed

Annotations 'tab' and 'group' in Camel Case #3103

tobolar opened this issue Sep 2, 2019 · 5 comments · Fixed by #3110
Assignees
Labels
P: low Low priority issue task General work that is not related to a bug or feature
Milestone

Comments

@tobolar
Copy link
Contributor

tobolar commented Sep 2, 2019

Text indicated by the annotation tab is in some components Camel Case (e.g. Internal Interface for Medium in Modelica.Fluid.Machines.BaseClasses.PumpMonitoring.PumpMonitoringBase), in some not (e.g. Nominal resistances and inductances for Lrsigma in Modelica.Electrical.Machines.BasicMachines.InductionMachines.IM_SlipRing).

Similar mixing holds probably for the annotation group as well (I didn't check.).

@beutlich
Copy link
Member

beutlich commented Sep 4, 2019

Any preferences? I'd prefer to change "Internal Interface" to "Internal interface".

@DagBruck
Copy link
Contributor

DagBruck commented Sep 4, 2019

Not the biggest problem in the world, but my #1 preference is consistency.

I think most design guidelines I have seen suggest writing it as a normal sentence, i.e. "Internal interface".

@tobolar tobolar added the discussion Discussion issue that it not necessarily related to a concrete bug or feature label Sep 5, 2019
@tobolar
Copy link
Contributor Author

tobolar commented Sep 5, 2019

... my No.1 preference is consistency.

That's the point of this issue.

I have slight preference to use Came Case in tabs and "sentence-like" style in groups.
Tab's text is mostly short, containing just a guide word(s). I've check in web some screenshots of other software and my impression is that this is handled quite differently:
https://docs.microsoft.com/en-us/windows/win32/uxguide/ctrl-tabs
https://www.trueos.org/blog/lumina-screenshot-simple-utility-powerful-results/
https://blog.cloudhq.net/send-screenshots/
https://www.tightvnc.com/screenshots.php

@beutlich beutlich added the P: low Low priority issue label Sep 5, 2019
@DagBruck
Copy link
Contributor

DagBruck commented Sep 5, 2019

https://docs.microsoft.com/en-us/windows/win32/uxguide/ctrl-tabs

But that reference actually recommends "Use sentence-style capitalization", see the section Labels near the end. And their example follow that.

@tobolar
Copy link
Contributor Author

tobolar commented Sep 5, 2019

Fine to me. Their guidelines are quite clear and comprehensive so we could simply adopt it.

@beutlich beutlich self-assigned this Sep 5, 2019
@beutlich beutlich added task General work that is not related to a bug or feature and removed discussion Discussion issue that it not necessarily related to a concrete bug or feature labels Sep 5, 2019
@beutlich beutlich added this to the MSL4.0.0 milestone Sep 5, 2019
beutlich added a commit to beutlich/ModelicaStandardLibrary that referenced this issue Sep 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P: low Low priority issue task General work that is not related to a bug or feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants