Acknowledged
6 months ago

Typos on the Persisting Data page.

On the Persisting Data page, in the "Accessing Properties and Settings: Application.Properties" section, in the API column of the table, it says Properties.getValue(), and Storage.setValue(). I'm pretty sure the latter should be Properties.setValue().

Also, in the description column, it says "Store information by key in persisted storage. Property values must be defined in the application settings xml. If a key that is not present in application settings is passed to getValue(), an exception will be thrown", but it should say "setValue()" rather than "getValue()".

The docs are already somewhat confusing wrt to exactly what you should use each module for (partly because it depends on the api version) - but these typos just make things worse.

markw65
Parents
  • over 3 years ago in reply to jim_m_58

    Yes, I know that. But this section is describing the Properties API, but talks about Properties.getValue(), and Storage.setValue(). Clearly the latter should be Properties.setValue().

    And *then* in the description for "Storage".setValue() it says that Properties.getValue() will throw - which is true, but not relevant (and note that it already told us that on the row above). It should say that Properties.setValue() will throw.

    Maybe a picture will make it clearer. This section is all about Properties not Storage (the previous section was Storage), and in particular its documenting Properties.getValue() and Properties.setValue().

Comment
  • over 3 years ago in reply to jim_m_58

    Yes, I know that. But this section is describing the Properties API, but talks about Properties.getValue(), and Storage.setValue(). Clearly the latter should be Properties.setValue().

    And *then* in the description for "Storage".setValue() it says that Properties.getValue() will throw - which is true, but not relevant (and note that it already told us that on the row above). It should say that Properties.setValue() will throw.

    Maybe a picture will make it clearer. This section is all about Properties not Storage (the previous section was Storage), and in particular its documenting Properties.getValue() and Properties.setValue().

Children