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

Naming for Util #328

Closed
samreid opened this issue Aug 24, 2015 · 8 comments
Closed

Naming for Util #328

samreid opened this issue Aug 24, 2015 · 8 comments

Comments

@samreid
Copy link
Member

samreid commented Aug 24, 2015

We have a few different conventions for our Util classes.

Util.js found in dot, mobius, scenery, optics-lab, trig-tour
Utils.js found in shred, build-an-atom
Sim-specific util files as noted below, such as ChipperStringUtils.js
image

It would be nice to standardize on a naming for our utility files. Also, we decided long ago to use full names instead of abbreviations for many things--util seems to be one of the last holdouts. Let's discuss where to go from here. Also note having many files with the same name causes import conflicts and difficulty when navigating by filename.

Discovered this issue during phetsims/chipper#116

@jbphet
Copy link

jbphet commented Aug 25, 2015

Discussed at 8/25/2015 meeting and the consensus was that this doesn't bother us too much but if someone wants to make them consistent, it would make life slightly easier. Either Util or Utils is fine.

@pixelzoom
Copy link
Contributor

It would make life slightly easier if we picked either 'Utils' or 'Util' and used it consistently. I don't feel a need to expand to "Utilities", since it's such a common abbreviation.

@samreid
Copy link
Member Author

samreid commented Aug 25, 2015

What about renaming DOT/Util to DOT/DotUtil so that you can use it together with other Utils? etc.

@pixelzoom
Copy link
Contributor

What about renaming DOT/Util to DOT/DotUtil so that you can use it together with other Utils? etc.

See phetsims/dot#4

@pixelzoom pixelzoom assigned samreid and unassigned pixelzoom Aug 25, 2015
@samreid
Copy link
Member Author

samreid commented Aug 25, 2015

Ah right, thanks for reminding me about the dot issue. I'll unassign this.

@samreid samreid removed their assignment Aug 25, 2015
@ariel-phet
Copy link

What is the status of this issue, seems to have gone a bit stale?

@pixelzoom
Copy link
Contributor

The consensus (summarized in #328 (comment)) is that this is a minor inconvenience and a major pain to change, so someone will work on it if/when they feel the urge. Imo it's not tragic if it's never addressed; we have much bigger fish to fry.

@ariel-phet
Copy link

considering comment above, closing

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

No branches or pull requests

4 participants