Screen descriptionContent should use helpText for consistency

[jessegreenberg]

This option is used to set the help text of the home screen button for a particular screen

      // pdom/voicing - The description that is used when interacting with screen icons/buttons in joist (and home screen).
      // This is often a full but short sentence with a period at the end of it. This is also used for voicing this screen
      // in the home screen.
      descriptionContent: null,

We should change it to use helpText to for better consistency as we move toward using "accessible name" and "help text" throughout code components.

Came up while reviewing phetsims/models-of-the-hydrogen-atom#67 with @kathy-phet and @terracoda.

[jessegreenberg]

In phetsims/models-of-the-hydrogen-atom#73 (comment) @pixelzoom recommended

- descriptionContent?: PDOMValueType | null;
+ // Help text that will be added to the Home screen button and navigation bar button for this screen.
+ screenButtonsHelpText?: PDOMValueType | null;

[pixelzoom]

@jessegreenberg When the API is changed, feel free to update MOTHA. I added 2 TODOs that link to this issue.

[jessegreenberg]

OK, this is done. I updated usages, including the two in MOTHA and removed the TODOs. I also updated string keys under the a11y key based on a comment about how they were confusing before in phetsims/models-of-the-hydrogen-atom#73 (comment).

Here is the main joist commit: e3366b8 with some cleanup in 07dea6d.

@pixelzoom would you mind reviewing this?

[pixelzoom]

Commits look good.

Should the default helpText match the default for the Home Screen button? That is "Go to {{screenName}} Screen." rather than just "{{screenName}} Screen". See screenshot below.

[jessegreenberg]

Yes, and that is a better default. Anything else for this?

[pixelzoom]

Looking good!

In joist-strings_en.json:

    "home": {
      "value": "Home"
    },

    "homeScreenDescription": {
      "value": "Go to Home Screen."
    },

    "goToScreenPattern": {
      "value": "Go to {{name}} Screen."
    },

Should homeScreenDescription be replaced with goToScreenPattern? This would ensure consistency going forward.

[terracoda]

@pixelzoom and @jessegreenberg, I also like "Go to" as a default, and hopefully folks will design screen button help text that's more directly relevant. Great default, though!

[jessegreenberg]

Thanks @terracoda, sounds good.

Good point @pixelzoom, done in the above commit. Can you please review?

[pixelzoom]

Looks good, but I'm not sure if it's safe to totally remove a string from joist-strings_en.json (homeScreenDescription in this case). @jessegreenberg please verify with @jbphet.

[jessegreenberg]

Thanks for reviewing. It is safe to remove strings under the a11y key, I confirmed this with @jbphet for another issue a few weeks ago.

Closing.