Skip to content

Commit

Permalink
change docs related to custom options, see #168
Browse files Browse the repository at this point in the history
  • Loading branch information
jbphet committed Sep 10, 2022
1 parent 89ea31a commit 4cc60ae
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions js/common/GreenhouseEffectQueryParameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import greenhouseEffect from '../greenhouseEffect.js';

const GreenhouseEffectQueryParameters = QueryStringMachine.getAll( {

// This flag can be used to enable an "Options" dialog that is available from the PhET menu. This is used to enable
// designers to test drive some alternative sounds, see mockups and so forth.
// This flag can be used to enable custom sim-specific options in the Preferences dialog. This is used to enable
// designers to test drive some alternative sounds, see mockups, and so forth.
// TODO: This query parameter and the associated dialog should be completely removed prior to publication, see
// https://github.com/phetsims/greenhouse-effect/issues/168.
// https://github.com/phetsims/greenhouse-effect/issues/179.
customPreferences: { type: 'flag' },

// This threshold value is used to decide when an EnergyAbsorbingEmittingLayer is considered to be in equilibrium,
Expand Down
6 changes: 3 additions & 3 deletions js/greenhouse-effect-main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ const simOptions: SimOptions = {
hasKeyboardHelpContent: true
};

// If the appropriate query parameter is set, add an "Options" dialog that designers can use to try out different
// design choices.
// TODO: This should be removed before publication, see https://github.com/phetsims/greenhouse-effect/issues/168.
// If the appropriate query parameter is set, add controls to the Preferences dialog that designers can use to try out
// different design choices.
// TODO: This should be removed before publication, see https://github.com/phetsims/greenhouse-effect/issues/179.
if ( GreenhouseEffectQueryParameters.customPreferences ) {
simOptions.preferencesModel = new PreferencesModel( {
simulationOptions: {
Expand Down

0 comments on commit 4cc60ae

Please sign in to comment.