You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We previously made the I18n class private in order to give us the freedom to make changes to the implementation after shipping it. Once we're happy with the implementation, we should make it public so that people building other components can re-use it.
Who needs to work on this
Developers
Who needs to review this
Developers, tech writer
Done when
We're happy with the name of the class
Any internal methods are private (either marked with a @private annotation or actually encapsulated as private)
Annotations mark the class as public
The class can be consumed by users of GOV.UK Frontend
Documentation for the class published in API reference etc
The text was updated successfully, but these errors were encountered:
I've added another 'done when' to ensure that we clearly delineate which methods are designed to be called from outside of the class and which are 'internal' – at the minute the class itself is private but the methods do not have access annotations.
What
Make the I18n public by removing any
@private
annotations and exporting it in a way that it can be consumed by users of GOV.UK Frontend.Include documentation for the class in any user-facing documentation (e.g. the JS API Reference)
Before we do this we should make sure we're happy with the name of the class.
Why
We previously made the I18n class private in order to give us the freedom to make changes to the implementation after shipping it. Once we're happy with the implementation, we should make it public so that people building other components can re-use it.
Who needs to work on this
Developers
Who needs to review this
Developers, tech writer
Done when
@private
annotation or actually encapsulated as private)The text was updated successfully, but these errors were encountered: