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

Remane CombEnvelope to HoneyCombEnvelope #185

Open
aveXcaesar opened this issue Apr 18, 2024 · 1 comment
Open

Remane CombEnvelope to HoneyCombEnvelope #185

aveXcaesar opened this issue Apr 18, 2024 · 1 comment
Labels
Internal Refactoring This doesn't seem right

Comments

@aveXcaesar
Copy link
Contributor

Expected Behavior

I can find the envelope object for IHoneyComb intuitively.
The usual naming rule is to name the envelope object similar to the interface name:
IHoneyComb -> HoneyCombEnvelope

Actual Behavior

The envelope object is named CombEnvelope

Steps to reproduce the behavior

The log given by the failure.

Mention any other details that might be useful

@aveXcaesar aveXcaesar added the Internal Refactoring This doesn't seem right label Apr 18, 2024
@Meerownymous
Copy link
Contributor

I had chosen CombEnvelope to follow the paradigma that names should be short to allow for quick reading. I think when working with the library, it should be quickly learned that the name is CombEnvelope, as it is also placed in the "Comb" folder. Otherwise I would rename IHoneyComb to IComb rather than the other way around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Internal Refactoring This doesn't seem right
Projects
None yet
Development

No branches or pull requests

2 participants