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

inconsistent naming of Enumerations #273

Closed
pixelzoom opened this issue Dec 18, 2018 · 9 comments
Closed

inconsistent naming of Enumerations #273

pixelzoom opened this issue Dec 18, 2018 · 9 comments

Comments

@pixelzoom
Copy link
Contributor

Related to code review #259.

There are currently 2 patterns used to name Enumerations:

(1) 'Enum' suffix: BarrierTypeEnum, PlaySpeedEnum

(2) 'Type' suffix: ApertureType, SoundViewType, SceneType, ViewType, WaveSpatialType, WaveTemporalType

I don't have a preference on which pattern is used, but it would be nice to pick one.

@pixelzoom
Copy link
Contributor Author

And I don't think we need to necessarily be consist across all sims, just within a sim.

@samreid
Copy link
Member

samreid commented Dec 18, 2018

It seems it would be best for this sim to change:

BarrierTypeEnum => BarrierType
PlaySpeedEnum => PlaySpeedType

@pixelzoom
Copy link
Contributor Author

I guess I do have a preference. 'Type' is misleading. These are not types, they are enumerations. So I think 'Enum' is the appropriate suffix.

@samreid
Copy link
Member

samreid commented Dec 18, 2018

So will several of these end with TypeEnum? For instance, ApertureEnum sounds incorrect because it doesn't enumerate apertures, it enumerates aperture types.

@pixelzoom
Copy link
Contributor Author

If it makes life easier, I'm OK with 'Type' suffix.

@pixelzoom pixelzoom removed their assignment Dec 19, 2018
@samreid
Copy link
Member

samreid commented Dec 19, 2018

Do you prefer ApertureType or ApertureTypeEnum?

@pixelzoom pixelzoom removed their assignment Dec 19, 2018
@pixelzoom
Copy link
Contributor Author

pixelzoom commented Dec 19, 2018

ApertureType if you choose to use 'Type' suffix; ApertureTypeEnum if you choose to use 'Enum' suffix.

samreid added a commit that referenced this issue Dec 20, 2018
@samreid
Copy link
Member

samreid commented Dec 20, 2018

Enum suffix added, please review.

@pixelzoom
Copy link
Contributor Author

👍 Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants