Skip to content
New issue

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

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

Already on GitHub? # to your account

improve capitalization of macro names #49

Open
VladimirAlexiev opened this issue Dec 9, 2024 · 1 comment
Open

improve capitalization of macro names #49

VladimirAlexiev opened this issue Dec 9, 2024 · 1 comment

Comments

@VladimirAlexiev
Copy link

VladimirAlexiev commented Dec 9, 2024

I think these names are hard to read:

PUMLARUAAddTaggedValue
PUMLARUAInterface
PUMLARUADescr

I guess that RUA stands for "reusable asset"... but seeing so many uppercase chars and trying to remember them is tiring.

I think it would be better to spell them as

PumlaReusableAssetTaggedValue
PumlaReusableAssetInterface
PumlaReusableAssetDescr

Or you could omit the word "Reusable" to make it shorter.

This name is better:

PUMLAReUsableAssetFinalize

But I think this would be even better:

PumlaAssetFinalize
@DrMarkusVoss
Copy link
Owner

Thanks for your suggestion.

You are right, RUA stands for "Re-usable Asset". The fact that sometimes there is a "RUA" infix, sometimes not is that some of the macros relate to elements that are defined with the "Re-usable Element" macro, and others are more general and not depending on how the re-usable element has been created. The RUA approach came in later, the other ways of creating re-usable elements are not used and documented anymore (though still possible). But you are right, mentioning it explicitly might not bring a big benefit anymore. I will recheck the need for this.

When it comes to abbreviation in general, it is hard to make everyone happy. Especially in the "PlantUML" world a lot of persons are driven by reducing the number of characters to a minimum for a description. I personally agree that names should be readable and not abbreviated to non-understandable character sequences. For the "RUA" I made an exception.

I will consider your proposals for future releases. I am not sure yet when it will be.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants