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

Update phetioDocumentation of block massProperty #152

Closed
arouinfar opened this issue Mar 20, 2023 · 3 comments
Closed

Update phetioDocumentation of block massProperty #152

arouinfar opened this issue Mar 20, 2023 · 3 comments

Comments

@arouinfar
Copy link
Contributor

For #150

In #126 the phetioDocumentation of several elements was updated, including massProperty.

Current documentation for a block's massProperty:

Current mass of the block. Changing the mass will result in changes to the material (and therefore density), but the volume will remain the same.

This is mostly inaccurate. The behavior depends on the screen. On Intro and Mystery, changing the mass will change the volume, keeping the density constant. The Compare screen behaves differently. The mass can be directly changed only for the "Same Mass" set of blocks. There, changing the mass will change the density (volume kept constant).

@jonathanolson is it possible to have different documentation on different screens? If not, let's use this instead:

Current mass of the block. Changing the mass will result in changes to the volume (Intro and Mystery Screens) or density (Compare Screen).

@arouinfar
Copy link
Contributor Author

@samreid I think this is an issue you could handle, so I'm co-assigning you. Please let me know if you have any questions.

@samreid
Copy link
Member

samreid commented Mar 24, 2023

Yes, the documentation can be different on each screen. However, in this case I feel it is preferable to have the same documentation since it is the same type of object in each screen and that it just behaves differently based on context. For instance, it would be confusing for a client to read the massProperty documentation on one screen and assume it meant the same thing everywhere. So I'll use the "let's use this instead" text. But please reassign @jonathanolson if it is more important to give different text on the different screens.

samreid added a commit to phetsims/density-buoyancy-common that referenced this issue Mar 24, 2023
@samreid samreid assigned arouinfar and unassigned jonathanolson and samreid Mar 24, 2023
@arouinfar
Copy link
Contributor Author

For instance, it would be confusing for a client to read the massProperty documentation on one screen and assume it meant the same thing everywhere.

Excellent point @samreid. I agree.

So I'll use the "let's use this instead" text.

Thanks, looks good in master, 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

3 participants