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

Avoid non-standard abbreviations #220

Closed
pixelzoom opened this issue Mar 3, 2024 · 2 comments
Closed

Avoid non-standard abbreviations #220

pixelzoom opened this issue Mar 3, 2024 · 2 comments

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Mar 3, 2024

For code review #32 ...

From the PhET coding conventions:

  • Names (types, variables, properties, Properties, functions,...) should be sufficiently descriptive and specific, and should avoid non-standard abbreviations. For example: ...

There are dozens of occurrences of the t abbreviation, like:

      derive: t => t.launcherProperty,

Sometimes t is a launcher, sometimes t is a field. All of these occur in the context of a relatively unusual use of DynamicProperty, and t doesn't make understanding that any easier.

@pixelzoom
Copy link
Contributor Author

pixelzoom commented Mar 3, 2024

In f269a55, I replaced t with field or launcher, as appropriate.

I searched for 'const ', 'let ', and ' => ', and skimmed the results. I don't see any other abbreviations.

Over to @samreid or @matthew-blackman to review, close if OK.

@samreid
Copy link
Member

samreid commented Mar 4, 2024

Excellent, thanks for correcting this. Closing.

@samreid samreid closed this as completed Mar 4, 2024
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

3 participants