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

"This Property" vs "This property" in phetioDocumentation. #201

Closed
pixelzoom opened this issue Feb 27, 2024 · 3 comments
Closed

"This Property" vs "This property" in phetioDocumentation. #201

pixelzoom opened this issue Feb 27, 2024 · 3 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

For code review #32 ...

I've mostly given up pointing out the difference between Property (uppercase) and property (lowercase), because I get the vibe that no one agrees that it's important, and because pointing it out hasn't changed anything. There are plenty of examples in code comments for this sim that I'm not going to report (or did I just report them? :)

But phetioDocumentation is public facing, and this sim contains a mixture of "This Property..." (correct) and "This property..." (incorrect). So whether you agree with whether Property vs property is significant, it seems worth choosing one and using it thoughout phetioDocumentation. I recommend choosing "This Property...".

@pixelzoom
Copy link
Contributor Author

One other thought.... You could avoid the entire issue by omitting the "This Property" bit, like this example for PDLModel singleOrContinuousProperty:

      phetioDocumentation: 'This property indicates whether the launcher is in single or continuous launch mode.',
      phetioDocumentation: 'Indicates whether the launcher is in single or continuous launch mode.',

@samreid
Copy link
Member

samreid commented Feb 27, 2024

Before starting, there are 162 occurrences of "Property" (capitalized) in the project. I will review all the lowercase ones and see which need to be promoted.

@samreid
Copy link
Member

samreid commented Feb 27, 2024

After the commit, there are 197 occurrences of "Property", so I upconverted 35 cases.

One other thought....

We felt that the complete sentences were nice here, so I kept them. Everything else seems good. Closing.

@samreid samreid closed this as completed Feb 27, 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