No use of phetioDocumentaton

[pixelzoom]

For code review #331 ...

• Do not use translated strings in phetioDocumentaton - it changes the PhET-iO API!

To verify this, I searched for "phetioDocumention". I was surprised to find that there are no occurrences in the entire greenhouse-effects repo. This may be OK, but wanted to make @arouinfar and @jbphet aware of this, in case there are any elements that would benefit from documentation.

[jbphet]

I just searched and found quite a few usages of the phetioDocumentation option. I'll paste my search results in a details section below.

@pixelzoom - I noticed in the comment above you said "phetioDocumention". Perhaps there was a typo in your search string?

Occurrences of 'phetioDocumentation' in Directory C:\Users\jbphet\git-dev\greenhouse-effect\js
Found Occurrences in Directory C:\Users\jbphet\git-dev\greenhouse-effect\js  (22 usages found)
    Unclassified  (22 usages found)
        git-dev  (22 usages found)
            greenhouse-effect\js\common\model  (18 usages found)
                AtmosphereLayer.ts  (1 usage found)
                    38 phetioDocumentation: 'Layer in the atmosphere that absorbs and emits energy. Layers are numbered low-to-high according to altitude.'
                ConcentrationModel.ts  (6 usages found)
                    52 phetioDocumentation: 'Describes the mode by which concentration is controlled, either by date or by value.'
                    65 phetioDocumentation: 'Various time periods or years that can be chosen to set a value for greenhouse gas concentrations'
                    111 phetioDocumentation: 'The concentration value as set by the slider when in \'by value\' mode.'
                    128 phetioDocumentation: 'The concentration value being used in the model, set via the slider or the date control.'
                    177 phetioDocumentation: 'Controls whether the cloud is enabled in the model when manually controlling the concentration.'
                    191 phetioDocumentation: 'When true, the cloud will reflect some of the incoming sunlight back into space.'
                EnergyAbsorbingEmittingLayer.ts  (2 usages found)
                    144 phetioDocumentation: 'Proportion, from 0 to 1, of light energy absorbed for interacting wavelengths.'
                    153 phetioDocumentation: 'True when the amount of energy being absorbed is roughly equal to the amount being radiated.'
                EnergyRateTracker.ts  (1 usage found)
                    88 phetioDocumentation: 'Amount of energy being produced or absorbed.'
                FluxSensor.ts  (1 usage found)
                    97 phetioDocumentation: 'The altitude of the flux sensor in the atmosphere.'
                GreenhouseEffectPreferences.ts  (2 usages found)
                    32 phetioDocumentation: 'The units in which temperature values are displayed by default.'
                    38 phetioDocumentation: 'shows cueing arrows on draggable elements'
                GroundLayer.ts  (1 usage found)
                    62 phetioDocumentation: 'Proportion of incident light reflected from the ground from 0 (no reflection) to 1 (all light is reflected).'
                LayersModel.ts  (2 usages found)
                    209 phetioDocumentation: 'Total energy coming into Earth\'s atmosphere.'
                    216 phetioDocumentation: 'Indicates whether the energy coming in from the sun is equal to that being radiated back ' +
                PhotonCollection.ts  (1 usage found)
                    116 phetioDocumentation: 'Controls whether all the simulated photons should be shown versus a subset of them.'
                TemperatureUnits.ts  (1 usage found)
                    18 phetioDocumentation: 'The units in which the temperature values are presented.'
            greenhouse-effect\js\common\view  (1 usage found)
                CloudCheckbox.ts  (1 usage found)
                    52 phetioDocumentation: 'The sim controls cloudCheckbox.visibleProperty. Set this to false to permanently hide the Cloud checkbox.'
            greenhouse-effect\js\layer-model\model  (2 usages found)
                LayerModelModel.ts  (2 usages found)
                    73 phetioDocumentation: 'The proportion of IR energy that should be absorbed by a layer when passing through it.'
                    96 phetioDocumentation: 'The number of modeled layers in the atmosphere that are absorbing some amount of IR energy'
            greenhouse-effect\js\waves\model  (1 usage found)
                WavesModel.ts  (1 usage found)
                    147 phetioDocumentation: 'Interactions between IR waves coming from the ground and the atmosphere'

[pixelzoom]

Yep, must've been a typo (face palm). Closing.